Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve doc build; fix Read the Docs config #560

Merged
merged 7 commits into from
Mar 24, 2023
Merged

Conversation

mdickinson
Copy link
Member

@mdickinson mdickinson commented Mar 24, 2023

Our Read the Docs build is currently failing. The proximate cause is that I removed the docs optional requirements when things got migrated to pyproject.toml, but I suspect that even with that fixed other things would have gone wrong.

This PR reworks the doc build a bit to make it more Read-the-Docs friendly:

  • Hook up the apidoc build in the Sphinx configuration file, so that we only need the usual sphinx-build -b html step to build the docs; the api documentation generation is taken care of for us. This ensures that the API docs will be included in the Read the Docs build.
  • Move the documentation requirements to docs/requirements.txt, and pin versions. (Without this, RtD will use Sphinx 1.8.6. See https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies for more info.)
  • Update the RtD configuration file.
  • Update the doc test build workflow and etstool.py for the above changes.

Test build on RtD: https://readthedocs.org/projects/envisage/builds/19891791/

Copy link
Contributor

@corranwebster corranwebster left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - one comment

.readthedocs.yaml Show resolved Hide resolved
@mdickinson mdickinson merged commit ac12b64 into main Mar 24, 2023
@mdickinson mdickinson deleted the doc-build-improvements branch March 24, 2023 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants