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

Test documentation builds #115

Merged
merged 1 commit into from
Dec 7, 2024
Merged

Conversation

kurtmckee
Copy link
Contributor

@kurtmckee kurtmckee commented Nov 20, 2024

ReadTheDocs hasn't built the documentation in over a year.

To help ensure that the documentation can build cleanly, this PR introduces a new tox build environment, docs, which tests that the documentation can build.

It also fixes a single warning issued by the new doc tests:

WARNING: html_static_path entry '_static' does not exist

Note

While working on this, it became clear that tox.ini is not maintained (Python 2.7 and 3.6 are the only defined Python versions to test). This can be addressed in a separate PR.

Also, it is strongly recommended that doc/requirements.txt pin exact dependency versions.
This PR does not address build reproducibility; it simply introduces testing of the documentation builds.

@acarapetis
Copy link
Collaborator

Thanks. You're right that the tox config is no longer maintained - I've just been relying on the circleci test matrix instead, which does the job fine.

@djrobstep would be good to get the webhook configured to autobuild rtd.

@acarapetis acarapetis merged commit 5f237b6 into djrobstep:master Dec 7, 2024
20 checks passed
@kurtmckee kurtmckee deleted the test-doc-builds branch December 7, 2024 01:47
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.

2 participants