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

Add sphinx project documentation #2

Open
Croydon-Brixton opened this issue Nov 25, 2024 · 2 comments
Open

Add sphinx project documentation #2

Croydon-Brixton opened this issue Nov 25, 2024 · 2 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@Croydon-Brixton
Copy link
Owner

Add Sphinx Project Documentation

Objective:
The goal of this issue is to integrate Sphinx for generating project documentation that we can then host on readthedocs.

Background

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. We can leverage its capabilities to auto-generate documentation from docstrings, organize documentation into multiple pages, and provide a searchable interface.
This project adheres to google-style docstrings which should facilitate the auto-docstring generation.

Tasks

  • Set up Sphinx in the project.
  • Install Sphinx.
  • Configure Sphinx in a docs/ directory.
  • Create initial documentation structure.
  • Define the layout for the documentation.
  • Create placeholder pages for different sections (Installation, Usage, API Reference, etc.).
  • Integrate Sphinx with ReadTheDocs for automatic deployment of the documentation.
  • Document the setup and usage of Sphinx in the README.md file to guide future documentation efforts.

Acceptance Criteria

  • Sphinx setup is complete and functional within the project repository.
  • Basic documentation structure is implemented and accessible.
  • Documentation is automatically built and deployed via ReadTheDocs when changes are pushed to the main branch.
  • README.md includes instructions on how to work with Sphinx and update documentation.
@Croydon-Brixton Croydon-Brixton added the good first issue Good for newcomers label Nov 25, 2024
@Gulin7
Copy link

Gulin7 commented Nov 26, 2024

Hi, @Croydon-Brixton , could I take this issue?

@Croydon-Brixton
Copy link
Owner Author

Absolutely -- you're welcome to take a crack at it! Thanks for offering (:

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