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

docs: add read the docs and organize the documents #1357

Merged
merged 7 commits into from
Mar 3, 2025
Merged

Conversation

ereali-aneo
Copy link
Contributor

@ereali-aneo ereali-aneo commented Jan 23, 2025

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

  • Refactored the toctree to create a more intuitive hierarchy for documentation.
  • Organized Markdown (.md) files into logical sections with collapsible folders.
  • Configured Read the Docs (conf.py, myst_parser, etc.) to support Markdown properly.
  • Improved the sidebar navigation by grouping related topics under relevant categories.

These changes enhance the documentation experience for both new and experienced users.


Testing

  • Built the documentation locally using Sphinx to verify that the toctree renders correctly.
  • Ensured all links and cross-references function properly.
  • Verified that Markdown files are correctly parsed and displayed.

Impact

  • Documentation: The structure is now clearer, making it easier for users to navigate.
  • Configuration: Added/modified conf.py settings to support Markdown (myst_parser).
  • Performance: No impact on performance, as this only affects documentation.
  • Dependencies: If myst-parser was not previously installed, it needs to be added (pip install myst-parser).
  • Behavior: No functional changes to the codebase, only improvements in documentation accessibility.

Additional Information

  • If necessary, update any links in the project that point to the old documentation structure.
  • Ensure the Read the Docs build process is running smoothly with these changes.
  • This PR does not modify any production code but significantly improves documentation usability.

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • I have thoroughly tested my modifications and added tests when necessary.
  • Tests pass locally and in the CI.
  • I have assessed the performance impact of my modifications.

@ereali-aneo ereali-aneo changed the title Er/readthe doc docs: add read the docs and organize the documents Feb 4, 2025
@ereali-aneo ereali-aneo marked this pull request as ready for review February 12, 2025 15:44
@ereali-aneo ereali-aneo force-pushed the er/ReadtheDoc branch 2 times, most recently from 4afeda4 to d5f0f02 Compare February 28, 2025 08:51
aneojgurhem
aneojgurhem previously approved these changes Feb 28, 2025
aneojgurhem
aneojgurhem previously approved these changes Mar 3, 2025
Copy link

sonarqubecloud bot commented Mar 3, 2025

@aneojgurhem aneojgurhem merged commit 26d9e5d into main Mar 3, 2025
11 checks passed
@aneojgurhem aneojgurhem deleted the er/ReadtheDoc branch March 3, 2025 22:08
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