Skip to content

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

Merged
merged 9 commits into from
Sep 20, 2020

Conversation

KingDarBoja
Copy link
Contributor

@KingDarBoja KingDarBoja commented Jul 19, 2020

References #89

So far so good, to generate the docs just run sphinx-build -b html -EW docs docs/_build/html and navigate to docs/_build/index.html and that's it!

However, the index is not listing anything whereas the modindex isn't being generated.

@KingDarBoja KingDarBoja added type: documentation An issue or pull request for improving or updating the documentation type: chore Changes to the build process or auxiliary tools and libraries such as documentation generation labels Jul 19, 2020
@KingDarBoja KingDarBoja added this to the Version 3.0 milestone Jul 19, 2020
@KingDarBoja KingDarBoja requested review from Cito and leszekhanusz July 19, 2020 23:01
@KingDarBoja KingDarBoja self-assigned this Jul 19, 2020
@coveralls
Copy link

coveralls commented Jul 19, 2020

Coverage Status

Coverage remained the same at 100.0% when pulling d2ae379 on KingDarBoja:sphinx-docs into 8fc378d on graphql-python:master.

Copy link
Collaborator

@leszekhanusz leszekhanusz left a 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 order
  • fix 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)

@KingDarBoja
Copy link
Contributor Author

KingDarBoja commented Jul 20, 2020

  • 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. 🚀

@KingDarBoja KingDarBoja requested a review from leszekhanusz July 20, 2020 16:23
@KingDarBoja
Copy link
Contributor Author

If the structure is okay, then would be great to start moving the readme into a subsection called "usage" like graphql-core docs does.

@leszekhanusz
Copy link
Collaborator

leszekhanusz commented Sep 20, 2020

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

@leszekhanusz
Copy link
Collaborator

First I still need to correct the references now...

@leszekhanusz
Copy link
Collaborator

Note: I improved the class references but I removed the DSL module reference for now (no time and it will probably change...)

@KingDarBoja
Copy link
Contributor Author

Outstanding documentation, everything seems to be well documented. I will provide a separate section for DSL in the short term.

@KingDarBoja KingDarBoja merged commit 29aba29 into graphql-python:master Sep 20, 2020
@KingDarBoja KingDarBoja deleted the sphinx-docs branch September 20, 2020 19:53
leszekhanusz added a commit to leszekhanusz/gql that referenced this pull request Oct 3, 2020
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: chore Changes to the build process or auxiliary tools and libraries such as documentation generation type: documentation An issue or pull request for improving or updating the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants