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

Documentation: Create docs folder and setup basic Sphinx documentation #95

Open
vprusso opened this issue Aug 9, 2023 · 0 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@vprusso
Copy link
Contributor

vprusso commented Aug 9, 2023

We should create a docs/ folder in the root directory of the project and set up a basic Sphinx documentation page.

The quickstart guide for setting this up could be followed almost exactly to set this up for the project:
https://www.sphinx-doc.org/en/master/usage/quickstart.html

@vprusso vprusso added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 9, 2023
@WrathfulSpatula WrathfulSpatula added the unitaryhack-bounty unitaryhack-bounty label May 3, 2024
@WrathfulSpatula WrathfulSpatula removed the unitaryhack-bounty unitaryhack-bounty label May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants