-
Notifications
You must be signed in to change notification settings - Fork 184
chore: generate docs with sphinx #117
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
Conversation
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.
Good start!
Todo:
fix import orderfix manifest errors- we will need to sanitize all the help comments in the docs so that the methods are correctly explained
is it possible to hide private methods in the docs ? (starting with an underscore)
Yes, in this case would be manually importing every function/class per module instead of dumping all as I did. In fact, that was my original approach but as I wasn't sure how many stuff was going to be displayed on the docs, I went for the generic solution. EDIT Feel free to check again, I hide all private members as requested. 🚀 |
If the structure is okay, then would be great to start moving the readme into a subsection called "usage" like graphql-core docs does. |
Note: I created the gql project on readthedocs.io and I think the webhook is in place so if I understand correctly, once we merge this PR it should be visible on gql.readthedocs.io |
First I still need to correct the references now... |
Note: I improved the class references but I removed the DSL module reference for now (no time and it will probably change...) |
Outstanding documentation, everything seems to be well documented. I will provide a separate section for DSL in the short term. |
* chore: generate docs with sphinx * chore: avoid documenting private members * chore: add docs to manifiest * chore: manually document every class on transport * Write docs in sphinx rst format * fix manifest * Improve classes reference documentation Co-authored-by: Hanusz Leszek <[email protected]>
References #89
So far so good, to generate the docs just run
sphinx-build -b html -EW docs docs/_build/html
and navigate todocs/_build/index.html
and that's it!However, the index is not listing anything whereas the modindex isn't being generated.