Skip to content

polish docs references and troubleshooting#28

Merged
AllanChain merged 1 commit into
mainfrom
fix/docs-minor
Jun 19, 2026
Merged

polish docs references and troubleshooting#28
AllanChain merged 1 commit into
mainfrom
fix/docs-minor

Conversation

@AllanChain

@AllanChain AllanChain commented Apr 28, 2026

Copy link
Copy Markdown
Member
  • Fixes docs source links by setting the docs path for the theme.
  • Adds the Read the Docs 404 page extension.
  • Redirect to https://jaqmc.readthedocs.io/ for users still using the
    GitHub Pages site.
  • Preserves full field descriptions in generated config references
    instead of truncating them to the first sentence.
  • Replace graphviz workflow illustration with SVG.
  • Clarify density defaults and dimensionality.
  • Fix the wording to further distinguish semi-local ECP and PH.
  • Update the troubleshooting page to make it more useful.
  • Fix extra space around math
  • Improve periodic boundary condition page

@AllanChain AllanChain changed the title Fix/docs minor fix source buttons and config references in docs Apr 28, 2026
@codecov-commenter

codecov-commenter commented Apr 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.04%. Comparing base (37ccc5d) to head (8c1fbbe).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #28      +/-   ##
==========================================
- Coverage   87.05%   87.04%   -0.02%     
==========================================
  Files         132      132              
  Lines        6150     6150              
  Branches      587      587              
==========================================
- Hits         5354     5353       -1     
- Misses        557      558       +1     
  Partials      239      239              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@AllanChain AllanChain changed the title fix source buttons and config references in docs polish docs references and setup guidance Apr 29, 2026
@AllanChain AllanChain changed the title polish docs references and setup guidance polish docs references and troubleshooting Apr 29, 2026
@AllanChain AllanChain marked this pull request as draft April 29, 2026 06:56
@AllanChain AllanChain force-pushed the fix/docs-minor branch 2 times, most recently from e306aa4 to 9459c2d Compare May 4, 2026 00:37
@AllanChain AllanChain marked this pull request as ready for review May 4, 2026 00:37
@AllanChain AllanChain marked this pull request as draft June 12, 2026 02:26
@AllanChain AllanChain force-pushed the fix/docs-minor branch 2 times, most recently from e5e354b to 62fdd84 Compare June 17, 2026 15:34
@AllanChain AllanChain marked this pull request as ready for review June 17, 2026 15:34
- Fixes docs source links by setting the docs path for the theme.
- Adds the Read the Docs 404 page extension.
- Redirect to https://jaqmc.readthedocs.io/ for users still using the
GitHub Pages site.
- Preserves full field descriptions in generated config references
instead of truncating them to the first sentence.
- Replace graphviz workflow illustration with SVG.
- Clarify density defaults and dimensionality.
- Fix the wording to further distinguish semi-local ECP and PH.
- Update the troubleshooting page to make it more useful.
- Fix extra space around math
- Improve periodic boundary condition page
@AllanChain AllanChain merged commit 43d06e7 into main Jun 19, 2026
13 checks passed
@AllanChain AllanChain deleted the fix/docs-minor branch June 19, 2026 02:34
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.

3 participants