Issue #17: Sphinx documentation

[johnowagon]

Description

Part of #17

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

How should this pull request be reviewed?

• [X] By commit
• [ ] All changes at once

Type of change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

• [ ] Unit tests (General Environment only) pytest --cov bsk_rl/envs/general_satellite_tasking --cov-report term-missing tests/unittest
• [ ] Integrated tests (General Environment only) pytest --cov bsk_rl/envs/general_satellite_tasking --cov-report term-missing tests/integration

Does not change code functionality

Test Configuration

• Python: [3.10.1]
  • Basilisk: [2.2.0]
• Platform: [OSX 12.6.6]

Checklist:

• [X] My code follows the style guidelines of this project (passes Black, ruff, and isort)
• [x] I have performed a self-review of my code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] Commit messages are atomic, are in the form Issue #XXX: Message and have a useful message
• [x] My changes generate no new warnings
• [X] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes

To test locally since auto-generated documentation files are not being tracked by git: From project root:

sphinx-apidoc -e -f -o docs/source/documentation src/bsk_rl/
cd docs && make html

The output pages can be viewed from docs/build/html/index.html. Note that some pieces of documentation may look wrong, this is due to some syntax errors in docstrings, #94 addresses and fixes these issues.

[Mark2000]

Updated to not use sphinx-apidoc for more flexibility. Currently running make html in the docs folder should build everything.

[Mark2000]

@LorenzzoQM addressed your comments and ready for approval

[LorenzzoQM]

Thanks for making those changes. I just approved the pull request. This documentation is an excellent addition to the repo!