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 sphinx documentation of API functionality #114

Merged
merged 7 commits into from
Jan 2, 2020
Merged

Conversation

corviday
Copy link
Contributor

@corviday corviday commented Dec 17, 2019

Adds sphinx for API documentation.

Because we prefer Markdown to reStructured Text, almost all text is written in markdown files that are then included into the rST files with m2r, and sphinx's native rST files are used for structure only. The exceptions are the main index file, and the help for the metadata endpoint, which takes advantage of functionality only available in rST to put a big red warning box on the page.

There are no real changes to any files outside the newly created folder /doc, just whitespace formatting on docstrings of API endpoint functions to make them display better in sphinx, and transferring a docstring to a different function in watershed.py.

doc/source/overview.md Outdated Show resolved Hide resolved
doc/source/overview.md Outdated Show resolved Hide resolved
doc/source/overview.md Outdated Show resolved Hide resolved
doc/source/overview.md Outdated Show resolved Hide resolved
doc/source/overview.md Outdated Show resolved Hide resolved
doc/source/workflow.md Outdated Show resolved Hide resolved
doc/source/workflow.md Outdated Show resolved Hide resolved
doc/source/workflow.md Outdated Show resolved Hide resolved
doc/source/workflow.md Outdated Show resolved Hide resolved
doc/source/workflow.md Outdated Show resolved Hide resolved
@corviday corviday force-pushed the sphinx-doc branch 2 times, most recently from 04a284a to 3bc55bc Compare December 18, 2019 20:48
@corviday
Copy link
Contributor Author

@nikola-rados , could you look over this when you have time?

  • Try downloading the branch and see if the documentation builds correctly (instructions have been added to the README).

  • If documentation builds correctly, it will show up in doc/build/html. Read the documentation and see if it all seems correct, generally makes sense.

  • Let me know if you think of anything else I should cover?

Copy link
Contributor

@nikola-rados nikola-rados left a comment

Choose a reason for hiding this comment

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

The docs were successfully built. Looking through them I think they are comprehensive and no further additions are required. Great work!

@corviday
Copy link
Contributor Author

corviday commented Dec 19, 2019

  • add to the documentation documentation that you need to install latexmk to generate a PDF

@corviday corviday merged commit ab35507 into master Jan 2, 2020
@corviday corviday deleted the sphinx-doc branch January 2, 2020 17:12
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.

3 participants