Skip to content

chore: migrate docs to ReadTheDocs #53

@FBumann

Description

@FBumann

Summary

Migrate documentation hosting from GitHub Pages + mike to ReadTheDocs for automatic versioned docs from git tags.

Steps per package

  1. Add .readthedocs.yaml to repo root
  2. Connect repo at readthedocs.org
  3. Apply for open-source program (ad-free)
  4. Activate stable and latest versions in dashboard
  5. Remove mike deployment from GitHub Actions
  6. Remove gh-pages branch after confirming ReadTheDocs is live
  7. 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:
        - docs

Docs 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.yaml added to core repo
  • ReadTheDocs builds successfully from git tags
  • stable and latest versions available
  • mike/gh-pages deployment removed
  • README badges updated

Refs

Part of #47 — Architecture: Package Separation, SolutionResult Design, and Stability Tiers

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions