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

Migrate documentation to Sphinx. #89

Merged
merged 10 commits into from
Aug 27, 2024
Merged

Migrate documentation to Sphinx. #89

merged 10 commits into from
Aug 27, 2024

Conversation

hodgestar
Copy link
Contributor

Thanks https://github.com/dag/genshi/ for doing a lot of the nitpicky things 13 years ago.

This PR:

  • Converts the Markdown documentation to Sphinx RST.
  • Converts the API documentation to Sphinx autodoc.
  • Adds the Read the Docs configuration file.
  • Uses the sphinx-rtd-theme package to provide the theme.
  • Updates the README badge to point to the new documentation builds.

Preview of the documentation available at https://genshi-edgewall.readthedocs.io/en/feature-add-sphinx-docs/

@hodgestar hodgestar merged commit 3b7bf4c into master Aug 27, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant