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

Optimized Sphinx Configuration for Improved Documentation & Code Linking #272

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

SophiaLi20
Copy link

This PR improves the Sphinx documentation configuration by:

  • Enhancing readability & maintainability with structured sections.
  • Optimizing performance (reducing redundant sys.path.insert() calls).
  • Strengthening error handling in linkcode_resolve().
  • Making GitHub source links more reliable & cross-platform friendly.

Key Improvements

  • Better Structure → Grouped settings logically & added meaningful comments.
  • Cross-Platform Safe → Used os.path.join() & os.path.relpath().
  • More Reliable GitHub Linking → Handles class, method, & module-level linking.
  • Robust Error Handling → Prevents crashes when attributes are missing.

Next Steps
Run make clean && make html to test the build.
Let me know if there’s anything that could be improved further! Open to feedback and suggestions.

Looking forward to you thoughts!

@PaulWAyers PaulWAyers requested a review from Ali-Tehrani March 25, 2025 20:10
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.

1 participant