Skip to content

Add docs CI, API reference generator, and Read the Docs integration#108

Merged
Gonza10V merged 1 commit into
full_buildfrom
codex/add-github-workflow-for-read-the-docs
Jul 12, 2026
Merged

Add docs CI, API reference generator, and Read the Docs integration#108
Gonza10V merged 1 commit into
full_buildfrom
codex/add-github-workflow-for-read-the-docs

Conversation

@Gonza10V

Copy link
Copy Markdown
Contributor

Motivation

  • Provide automated documentation generation and ensure the API reference stays current by adding a CI job and a generator script.

Description

  • Add a GitHub Actions workflow ./github/workflows/docs.yml that installs dependencies, runs python tools/update_api_reference.py, builds the Sphinx site with sphinx-build -b html -W --keep-going docs docs/_build/html, and commits any regenerated docs/API_Reference.rst back to the repo.
  • Add tools/update_api_reference.py which discovers modules under src/buildcompiler, organizes them into ordered sections, and renders docs/API_Reference.rst with .. automodule:: entries and Sphinx directives.
  • Commit a generated docs/API_Reference.rst containing the current API layout produced by the generator.
  • Update README.md to include a Read the Docs badge and a short note linking to the documentation hosted at buildcompiler.readthedocs.io.

Testing

  • No automated tests were executed as part of this PR; the new CI workflow will run on pushes to main and build the documentation using the sphinx-build command specified in ./github/workflows/docs.yml.

Codex Task

@Gonza10V
Gonza10V merged commit 559e933 into full_build Jul 12, 2026
2 checks passed
@Gonza10V
Gonza10V deleted the codex/add-github-workflow-for-read-the-docs branch July 12, 2026 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant