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 sphinx documentation #52

Open
neishm opened this issue Apr 8, 2023 · 1 comment
Open

Add sphinx documentation #52

neishm opened this issue Apr 8, 2023 · 1 comment

Comments

@neishm
Copy link
Owner

neishm commented Apr 8, 2023

Should probably document the Python interface, and add some examples? Some simple examples are in the root README.md, but could have some more detailed examples in separate .rst files? Need to figure out long-term were the examples will reside - already have stuff int the README.md, and on the internal (CMC) wiki, so now adding .rst files as a third location? Is this situation sustainable?

Should also find the best way to maintain French translations for docs (for reference: https://www.sphinx-doc.org/en/master/usage/advanced/intl.html)

Received some instructions from Sebastien Fortier for setting up sphinx docs, need to try it out.

@neishm
Copy link
Owner Author

neishm commented Apr 25, 2023

With the help of Sebastien's documentation setup, I managed to get some sphinx documentation generated from a notebook. It's internal for now. Could make a copy on the public side once docs are more complete.

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