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 Operational guide #1

Open
mcayanan opened this issue Mar 13, 2019 · 0 comments
Open

Add Operational guide #1

mcayanan opened this issue Mar 13, 2019 · 0 comments
Labels

Comments

@mcayanan
Copy link

An Inspect Tool Operational guide needs to be added. Initial work was done, but in Word format. It can be obtained by going to the OODT JIRA site:

https://oodt.jpl.nasa.gov/jira/browse/PDS-662

According to @nutjob4life, a lot of open source Python projects are documented at https://readthedocs.org/ (and you can sign in with your GitHub ID and automatically import your projects) and it supports the Sphinx format. Sphinx also lets you use reStructuredText (more common in the Python community) or Markdown (but with limited features).

See also this recommendation for Sphinx for Python: https://python-docs.readthedocs.io/en/latest/writing/documentation.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: ToDo
Development

No branches or pull requests

2 participants