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

Use Sphinx to generate API docs #281

Merged
merged 4 commits into from
Aug 13, 2021
Merged

Use Sphinx to generate API docs #281

merged 4 commits into from
Aug 13, 2021

Conversation

lbalmaceda
Copy link
Contributor

Changes

Sphinx was set up with an old version which was completely broken. This PR does:

  • Update Sphinx to the latest version, re-running the quickstart.
  • Use the read-the-docs theme
  • Fix the content to be displayed, both at the home page and sidebar of the generated documentation.
  • Update the README headers, reorganizing sections into a more readable doc.
  • Git-Ignore the generated docs, as those will be generated and hosted by https://readthedocs.com/.

The docs are generated by changing the directory into /docs and running make html.

Screen Shot 2021-08-12 at 12 05 18

The resulting index page will display the README contents first and on the sidebar the API docs.

image

How to review this PR

Is better to clone the PR, generate the docs, and open the resulting index.html file.

References

@lbalmaceda lbalmaceda added CH: Added medium Medium review labels Aug 12, 2021
@lbalmaceda lbalmaceda requested a review from a team as a code owner August 12, 2021 10:35
@lbalmaceda lbalmaceda added this to the v3-Next milestone Aug 12, 2021
jtemporal
jtemporal previously approved these changes Aug 12, 2021
Copy link
Contributor

@jtemporal jtemporal left a comment

Choose a reason for hiding this comment

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

👏 🎉 LGTM

@lbalmaceda lbalmaceda linked an issue Aug 12, 2021 that may be closed by this pull request
@lbalmaceda lbalmaceda merged commit e24356f into master Aug 13, 2021
@lbalmaceda lbalmaceda deleted the autodocs branch August 13, 2021 08:51
@lbalmaceda lbalmaceda modified the milestones: v3-Next, 3.17.0 Aug 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CH: Added medium Medium review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs not available [SDK-1942]
2 participants