-
Notifications
You must be signed in to change notification settings - Fork 1
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
Conversation
04a284a
to
3bc55bc
Compare
@nikola-rados , could you look over this when you have time?
|
There was a problem hiding this 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!
|
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 themetadata
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 inwatershed.py
.