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

DOCS: Add documentation #34

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

esavary
Copy link
Member

@esavary esavary commented May 6, 2024

  • Update the README to reflect recent changes in the interface.
  • Initiate the creation of a more comprehensive documentation that can be generated with Sphinx. This documentation includes instructions on how to use the app and access the database.

To preview the rendering, run the following command:
sphinx-build -M html docs/source path-output

closes #19

@esavary esavary requested a review from celprov May 6, 2024 12:42
docs/source/conf.py Outdated Show resolved Hide resolved
Co-authored-by: Oscar Esteban <[email protected]>
@oesteban
Copy link
Member

oesteban commented May 14, 2024 via email

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.

Develop the documentation
2 participants