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

Cleanup Sphinx documentation #32

Open
lundybernard opened this issue Jul 27, 2024 · 1 comment
Open

Cleanup Sphinx documentation #32

lundybernard opened this issue Jul 27, 2024 · 1 comment
Labels
good first issue Good for newcomers

Comments

@lundybernard
Copy link
Owner

The documentation needs to be reviewed and cleaned up.
Feel free to take on smaller tasks and open new Issues to track them.

Some things that need improvement:

  • Auto-generated API documentation
  • Add a detailed User Guide
  • Enable make docs from the project's root directory, so we don't need to cd into docs/
@lundybernard
Copy link
Owner Author

  • Add versions to the sphinx documentation on readthedocs.io, ensure 'latest' points to the latest released version.

@tomato-gits tomato-gits added the good first issue Good for newcomers label Feb 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants