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

Generate documentation with Sphinx #109

Open
StokesMIDE opened this issue Mar 25, 2022 · 1 comment
Open

Generate documentation with Sphinx #109

StokesMIDE opened this issue Mar 25, 2022 · 1 comment
Labels
development Development issues: package deployment, project organization, etc. documentation enhancement New feature or request

Comments

@StokesMIDE
Copy link
Member

The little bit of help in the README isn't great. We should get the package marked up and rendering with Sphinx, and host it on readthedocs.io, either directly on the site as a stand-alone, or within the Mide domain.
@StokesMIDE StokesMIDE added enhancement New feature or request documentation development Development issues: package deployment, project organization, etc. labels Mar 25, 2022
@StokesMIDE
Copy link
Member Author

Note: This also involves universally converting the docstrings markup from its current Epydoc-inspired format.

@logicalzero logicalzero mentioned this issue Aug 2, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
development Development issues: package deployment, project organization, etc. documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@StokesMIDE