ion
ion copied to clipboard
feat!: modernize documentation setup
trafficstars
This commit
- Adds an actually good looking sphinx setup
- Fixes many of the formatting errors in the current docs.
- Updates the docs for the formatting/linting CI, changed in #1659
- Updates the docs about eggs, removed in #1669
- Removes scripts that are no longer relevant due to the above PRs mentioned.
- Fixes some docstrings that incorrectly use the google docstring style (mostly due to incorrect whitespace)
Note that Ion still uses Sphinx, but some scripts may need to be updated (I updated all of the ones I noticed).
I just had this branch lying around, so I figured I would clean it up and see what the thoughts were.
[!NOTE] I just stole the Ion logo and changed some colors/fonts to make the logo. If anyone has a better logo, feel free to suggest it.
A good future idea might be to get people to write docs about each app.
[!WARNING] This is a breaking change in the sense that old links may break