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

Improve documentation and output of documentation #30

Closed
dccote opened this issue Apr 8, 2019 · 0 comments
Closed

Improve documentation and output of documentation #30

dccote opened this issue Apr 8, 2019 · 0 comments
Assignees
Labels
before publication Critical to fix before we publish enhancement New feature or request

Comments

@dccote
Copy link
Contributor

dccote commented Apr 8, 2019

Move to Sphynx and sphynx-style documentation because the current format looks like garbage.

  1. This requires looking through the different formats for Python documentation here: https://realpython.com/documenting-python-code/ and here: https://www.sphinx-doc.org/en/master/
  2. Using a simple test file such as rays.py, see what the output format looks like once it is formatted properly.
  3. Modify all source files to adopt the documentation format
  4. Create scripts to fully document and update when needed.
@dccote dccote added the enhancement New feature or request label Apr 8, 2019
@dccote dccote added the before publication Critical to fix before we publish label May 7, 2020
@dccote dccote added this to the Documentation format chosen milestone May 18, 2020
@dccote dccote closed this as completed May 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
before publication Critical to fix before we publish enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants