-
Notifications
You must be signed in to change notification settings - Fork 20
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
API Docs #51
Labels
Milestone
Comments
We are no longer using mkdocs, and instead using Sphinx. For the most part, API Docs are complete, but they could use a look through and seeing what might still be missing(some things may have docstrings and just not being included in the docs build). I don't think it is worth having API docs for the parsers directly as those are only really intended for internal use . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Docs are currently being re-worked and using mkdocs. The autogenerated API docs are also being re-done as part of this. Currently the docstrings themselves are about half way to being done I’d say.
The setup within mkdocs definitely still needs some more work.
Still need to do some experimentation and testing out different methods for this to see what works best.
The text was updated successfully, but these errors were encountered: