-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Summary
Migrate documentation hosting from GitHub Pages + mike to ReadTheDocs for automatic versioned docs from git tags.
Steps per package
- Add
.readthedocs.yamlto repo root - Connect repo at readthedocs.org
- Apply for open-source program (ad-free)
- Activate
stableandlatestversions in dashboard - Remove mike deployment from GitHub Actions
- Remove
gh-pagesbranch after confirming ReadTheDocs is live - Update README badge and links
.readthedocs.yaml
version: 2
build:
os: ubuntu-24.04
tools:
python: "3.12"
mkdocs:
configuration: mkdocs.yml
python:
install:
- method: pip
path: .
extra_requirements:
- docsDocs scope per site
- fluxopt core — model API, math formulation, constraints, effects, investment, stats accessor
- fluxopt-yaml — YAML syntax, CSV conventions, expression language, shorthand factories
- fluxopt-plot — plot methods, parameters, rendered examples from fixture solution
Acceptance Criteria
-
.readthedocs.yamladded to core repo - ReadTheDocs builds successfully from git tags
-
stableandlatestversions available - mike/gh-pages deployment removed
- README badges updated
Refs
Part of #47 — Architecture: Package Separation, SolutionResult Design, and Stability Tiers
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation