Add docs CI, API reference generator, and Read the Docs integration#108
Merged
Merged
Conversation
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
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.
Motivation
Description
./github/workflows/docs.ymlthat installs dependencies, runspython tools/update_api_reference.py, builds the Sphinx site withsphinx-build -b html -W --keep-going docs docs/_build/html, and commits any regenerateddocs/API_Reference.rstback to the repo.tools/update_api_reference.pywhich discovers modules undersrc/buildcompiler, organizes them into ordered sections, and rendersdocs/API_Reference.rstwith.. automodule::entries and Sphinx directives.docs/API_Reference.rstcontaining the current API layout produced by the generator.README.mdto include a Read the Docs badge and a short note linking to the documentation hosted atbuildcompiler.readthedocs.io.Testing
mainand build the documentation using thesphinx-buildcommand specified in./github/workflows/docs.yml.Codex Task