Repository navigation
Docs and ci - #1
Merged
Merged
Conversation
One-time `ruff format` over the codebase, plus the lint fixes it asked for: import sorting, three re-exports added to __all__ (Repair, repair, NuclideSummary), a leftover unused assignment in the decay drawing (separate_labels already sweeps every axes text), and a lambda assignment converted to a def. One docstring in compare.py reworded so Sphinx does not read |difference| as a reST substitution. Markdown files are excluded: the code blocks in docs/ use aligned trailing comments deliberately. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Sw3PSRzk6yM7McwqJgCdbE
The eight Markdown pages stay as they are; MyST parses them, and
GitHub-style heading anchors keep the existing #fragment cross-links
working. New: a landing page adapted from the README, and an API
reference generated by autosummary from the module docstrings, which
were already written in Sphinx reST (one page per module, re-exports
documented once at their defining module). Furo theme.
Figures are the committed PNGs; nothing renders at build time, so the
build needs neither the RIPL-3 mirror nor an ENSDF distribution.
Build with: pip install -e '.[docs]'
sphinx-build -W --keep-going -b html docs docs/_build/html
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Sw3PSRzk6yM7McwqJgCdbE
ci.yml on PR and push to main: ruff, pyright, pytest on 3.10-3.13. Everything but the test-mirror job uses a sparse checkout so the 1 GB RIPL-3 mirror never downloads; test-mirror alone checks out data/ and runs the mirror-gated tests. ENSDF-gated tests always skip in CI. docs.yml builds the site on PRs and uploads it as an artifact. pages.yml builds and deploys to beykyle.github.io/nook/ on push to main; requires Settings -> Pages -> Source set to "GitHub Actions". Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Sw3PSRzk6yM7McwqJgCdbE
This file contains hidden or 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
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.
No description provided.