-
Notifications
You must be signed in to change notification settings - Fork 17
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
docs: add read the docs and organize the documents #1357
Merged
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
af57356
to
6f378f5
Compare
aneojgurhem
reviewed
Feb 14, 2025
4afeda4
to
d5f0f02
Compare
d5f0f02
to
8f47bb5
Compare
aneojgurhem
previously approved these changes
Feb 28, 2025
a45fca1
to
7430cb7
Compare
aneojgurhem
previously approved these changes
Mar 3, 2025
7430cb7
to
7464d5e
Compare
|
aneojgurhem
approved these changes
Mar 3, 2025
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.
Motivation
The previous documentation structure was not optimized for navigation and usability. To improve clarity and ease of use, I restructured the
toctree
and integrated a Read the Docs interface. This will help users find information faster and better understand the documentation structure.Description
toctree
to create a more intuitive hierarchy for documentation..md
) files into logical sections with collapsible folders.conf.py
,myst_parser
, etc.) to support Markdown properly.These changes enhance the documentation experience for both new and experienced users.
Testing
toctree
renders correctly.Impact
conf.py
settings to support Markdown (myst_parser
).myst-parser
was not previously installed, it needs to be added (pip install myst-parser
).Additional Information
Checklist