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

feat!: modernize documentation setup #1714

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

JasonGrace2282
Copy link
Member

@JasonGrace2282 JasonGrace2282 commented Aug 25, 2024

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 Add pre-commit and use ruff #1659
  • Updates the docs about eggs, removed in Remove Ion.egg-info and build_sources.sh #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

Samples

@JasonGrace2282 JasonGrace2282 force-pushed the docs branch 3 times, most recently from 996ee91 to 4f90063 Compare August 25, 2024 19:07
@JasonGrace2282

This comment was marked as outdated.

@JasonGrace2282 JasonGrace2282 marked this pull request as ready for review August 25, 2024 19:17
@JasonGrace2282 JasonGrace2282 requested a review from a team as a code owner August 25, 2024 19:17
@coveralls
Copy link

coveralls commented Aug 25, 2024

Coverage Status

coverage: 79.338%. remained the same
when pulling 7790f6f on JasonGrace2282:docs
into 8cb7791 on tjcsl:dev.

@JasonGrace2282 JasonGrace2282 force-pushed the docs branch 2 times, most recently from 1bcc1a7 to b4465a3 Compare August 25, 2024 19:32
@JasonGrace2282 JasonGrace2282 force-pushed the docs branch 2 times, most recently from 0a6008e to ddf127d Compare September 11, 2024 20:56
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

Successfully merging this pull request may close these issues.

2 participants