Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Mkdocs as documentation framework #17

Merged
merged 1 commit into from
Jun 23, 2024

Conversation

scottstanie
Copy link
Contributor

Copying over the basic setup of documentation from dolphin. It uses MkDocs, and the MkdocStrings for autogenerating the reference material. Once you install the requirements in docs/requirements.txt, you can locally view the docs with mkdocs serve:
image

Other features:

image - You can make a jupyter notebook, store it in `docs/notebooks/`, and have it rendered in the docs. [See here for an example](https://dolphin-insar.readthedocs.io/en/latest/notebooks/walkthrough-basic/)

add 2 real refs, example citation
Copy link
Member

@piyushrpt piyushrpt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@scottstanie scottstanie merged commit baa0402 into isce-framework:main Jun 23, 2024
1 check passed
@scottstanie scottstanie deleted the mkdocs branch June 23, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants