Skip to content

Optimized Sphinx Configuration for Improved Documentation & Code Linking#272

Closed
Unnati-2061 wants to merge 1 commit into
theochem:masterfrom
Unnati-2061:master
Closed

Optimized Sphinx Configuration for Improved Documentation & Code Linking#272
Unnati-2061 wants to merge 1 commit into
theochem:masterfrom
Unnati-2061:master

Conversation

@Unnati-2061
Copy link
Copy Markdown

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
@marco-2023
Copy link
Copy Markdown
Collaborator

This PR has been open for quite some time, and after reviewing the changes, I believe they are primarily cosmetic and do not provide a meaningful improvement to the package. For that reason, I will be closing the PR.

@marco-2023 marco-2023 closed this May 20, 2026
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