docs: reorganise the doc + API docs + logo #191
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
…et-dev/jaxoplanet into docs_reorganize_logo_api
for more information, see https://pre-commit.ci
…et-dev/jaxoplanet into docs_reorganize_logo_api
for more information, see https://pre-commit.ci
…st list format (sphinx warning)
…et-dev/jaxoplanet into docs_reorganize_logo_api
lgrcia
requested review from
catrionamurray,
dfm,
soichiro-hattori and
jiayindong
lgrcia
changed the title
jiayindong
reviewed
Aug 7, 2024
…et-dev/jaxoplanet into docs_reorganize_logo_api
for more information, see https://pre-commit.ci
…et-dev/jaxoplanet into docs_reorganize_logo_api
for more information, see https://pre-commit.ci
…et-dev/jaxoplanet into docs_reorganize_logo_api
|
I am merging this one so that @soichiro-hattori can make its PR to this docs on the main. Please feel free to discuss and reopen any PR you find relevant regarding these changes. Thanks to everyone! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR proposes a bit of reorganization of the documentation, a logo and some more API documentation. Still some things to finish before being ready to merge. Please have a look to the rendered doc and let me know what you think!
Things I'm currently polishing:
Systemclassesedit: There is a lot of refactoring necessary on the different starry classes (e.g.
Ylm) but I reserve that for another PR.