Summary
Build the documentation site: API reference (Doxygen), user guide (Sphinx),
finished README, and CONTRIBUTING.
References
docs/06_build_test_packaging.md §5 (docs.yml), §7
docs/11_development_workflow.md (source for CONTRIBUTING)
Scope
Out of scope
Acceptance Criteria
docs.yml is green and the site is reachable via GitHub Pages
- C++ and Python API references render with docstrings in sync
- Link check passes (no dead or non-public references)
Dependencies
For the implementer
- Copy the checklist above into your PR description and tick items as you
complete them. Do not edit the checklist in this issue.
- Follow
docs/development_workflow.md (branch issue/34-docs-site,
Conventional Commits per §2.1).
- This issue is closed automatically by the PR via
Closes #34.
Summary
Build the documentation site: API reference (Doxygen), user guide (Sphinx),
finished README, and CONTRIBUTING.
References
docs/06_build_test_packaging.md§5 (docs.yml), §7docs/11_development_workflow.md(source for CONTRIBUTING)Scope
Doxyfile), Sphinx for guide + Python API(
docs/conf.py), unified via breathe or doxysphinx.github/workflows/docs.yml: build on push to main, publish toGitHub Pages
README.md: badges (CI, PyPI, docs), quickstart snippets(C++ & Python), architecture diagram
CONTRIBUTING.mdderived fromdocs/development_workflow.mdOut of scope
Acceptance Criteria
docs.ymlis green and the site is reachable via GitHub PagesDependencies
For the implementer
complete them. Do not edit the checklist in this issue.
docs/development_workflow.md(branchissue/34-docs-site,Conventional Commits per §2.1).
Closes #34.