Add docs - #53
Draft
kwabenantim wants to merge 1 commit into
Draft
Conversation
Expand the README into a full documentation site (Sphinx + Furo + MyST), built and deployed to GitHub Pages, addressing issue #45. Content pages cover: installation, first steps, command-line options, using generated code in Chaste user projects, the anatomy of the generated code, SBML feature support (with SBML Test Suite results), and worked tutorials for a simple SRN model (Goldbeter 1991) and a complex cell-cycle model with events (Tyson-Novak 2001). Also: - Add a docs CI workflow (build on every PR with -W, deploy from develop). - Add a `docs` extra and tidy the project metadata in pyproject.toml (keywords, classifiers, documentation/issues URLs; drop redundant isort settings already implied by profile = black and align its line length). - Link the docs site and add a build badge in the README. - Ignore doc/_build/. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012Fn8DBEftxqCRTNVinuLCh
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Fixes #45