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 (to a doc site) #5

Open
maread99 opened this issue May 19, 2022 · 0 comments
Open

Documentation (to a doc site) #5

maread99 opened this issue May 19, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@maread99
Copy link
Owner

It would be preferable for documentation to be built with Sphinx or MkDocs and published to a dedicated docs site.

Current documentation consists of:

  • README.md.
  • .ipynb notebook tutorials in docs/tutorials.
  • various .md files in the docs folder.
  • method docstrings (which are comprehensive).

It's all there, but it would be better prestented and easier to navigate if it were on a dedicated docs site.

It hopefully wouldn't be a huge task; the docs files are all .md and the docstrings are (aka 'should be') in numpy format.

Which one, Sphinx or MkDocs? Sphinx is probably more flexible, although would likely involve more work.

@maread99 maread99 added the documentation Improvements or additions to documentation label May 19, 2022
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
Projects
None yet
Development

No branches or pull requests

1 participant