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 documentation #2

Open
wtbarnes opened this issue Mar 17, 2021 · 0 comments
Open

Add documentation #2

wtbarnes opened this issue Mar 17, 2021 · 0 comments

Comments

@wtbarnes
Copy link

Currently, the only documentation for this software lies in PDF format under docs. It would be preferable if the documentation were instead formatted in a markup language and rendered as a webpage (e.g. using tools like Sphinx or mkdocs). This would allow the documentation to be version controlled and thus more easily maintained. In this format, the documentation could also be hosted on a service such as Read the Docs that would allow it to be more discoverable.

Additionally, tools like Sphinx would also support the automatic generation of API documentation that could be included in the built documentation.

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

No branches or pull requests

1 participant