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.

Sign up for GitHub

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

Jump to bottom

Setup sphinx docs #35

Open
JatGreer opened this issue Mar 6, 2024 · 2 comments
Open

Setup sphinx docs #35

JatGreer opened this issue Mar 6, 2024 · 2 comments
Assignees
@MJoosten @JatGreer
Labels
documentation Improvements or additions to documentation v0.3.0 Required for Roodmus v0.3.0

Comments

@JatGreer
Copy link
Contributor

JatGreer commented Mar 6, 2024

Possible setup could be similar to: alan-turing-institute/empiarreader#50
@JatGreer JatGreer added documentation Improvements or additions to documentation v0.3.0 Required for Roodmus v0.3.0 labels Mar 6, 2024
@JatGreer
Copy link
Contributor Author

JatGreer commented Mar 6, 2024

I'm halfway through creatings a sphinx docs, will try to make sure it stable tomorrow

@JatGreer
Copy link
Contributor Author

JatGreer commented Mar 7, 2024

docs, added - merged to development in v0.0.28.
Example here: https://roodmus.readthedocs.io/en/jgreer-docs/
Suggest to follow this style guide for writing docs: https://diataxis.fr/

Need to update to components of the docs and make sure docstrings/code is automatically picked up to make API docs, then merge that version into main/v0.3.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MJoosten MJoosten

@JatGreer JatGreer

Labels
documentation Improvements or additions to documentation v0.3.0 Required for Roodmus v0.3.0
Projects
Roodmus v0.3.0 utility
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MJoosten @JatGreer