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.

Sign up for GitHub

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

Jump to bottom

documentation build fixes for ReadTheDocs #450

Merged
merged 21 commits into from
Jan 18, 2023
Merged

documentation build fixes for ReadTheDocs #450

merged 21 commits into from
Jan 18, 2023

Conversation

tomkinsc
Copy link
Member

@tomkinsc
Copy link
Member Author

With jinja2 pinned the docs build is passing here on GitHub Actions, but still failing on RTD.

@tomkinsc
override sphinx pinning done by RTD
e777c0d 
override sphinx pinning done by RTD since, apparently, "Projects created before Oct 20, 2020 use 1.8.x. New projects use the latest version."
https://docs.readthedocs.io/en/stable/build-default-versions.html#external-dependencies
Overriding RTD's pinning of old sphinx is mentioned here:
https://docs.readthedocs.io/en/stable/config-file/v2.html?highlight=sphinx#sphinx
For now I'm setting the pin to be newer than the old pinned version, but we may need to be more explicit and limit to a particular range of versions
@tomkinsc tomkinsc changed the title pin jinja2<3.1 documentation build fixes for ReadTheDocs Jan 18, 2023
tomkinsc added 19 commits January 18, 2023 11:49
@tomkinsc
(debugging) omit jinja2 pinning
9630bd4
@tomkinsc
list jinja2 in requirements but without a version pin
9039a7b
@tomkinsc
set sphinx builder to "html" in the RTD config
86dc2b2
@tomkinsc
omit sphinx autodoc since this repo is for wdls not pythons
32d10b8
@tomkinsc
Update requirements.txt
d930695
@tomkinsc
Update requirements.txt
0f68d52
@tomkinsc
bump RTD python 3.6->3.8
0203fa7 
bump python 3.6->3.8 to match version used for building docs via GitHub Actions
@tomkinsc
comment out wdl_aid import in sphinx config
d5623ad 
comment out wdl_aid import in sphinx config for now since we're calling the CLI version via subprocess
@tomkinsc
try always explicitly specifying the sphinx_rtd_theme
e399fcd
@tomkinsc
revert toggle of RTD sphinx theme based on build environment
0e651a2
@tomkinsc
pass through error code on build-docs.sh failure
aecd7f0
@tomkinsc
invert
b909243
@tomkinsc
remove whitespace before sphinx config imports
2331a5d
@tomkinsc
capture and print wdl-aid output upon error
a518305
@tomkinsc
pip freeze after installing docs dependencies on GH actions
ca1fd20
@tomkinsc
bump python to 3.11 for RTD and GH Actions doc builds
0655ee7
@tomkinsc
explicitly pin most of the documentation build requirements
290c689
@tomkinsc
roll back python used for doc builds to 3.8
8327300 
roll back python used for doc builds to 3.8 since it's the newest version supported by RTD
@tomkinsc
add back sphinx autodoc extension
7e4bd02
@tomkinsc tomkinsc merged commit bfcb1e3 into master Jan 18, 2023
@tomkinsc tomkinsc deleted the ct-docs-build-debugging branch January 18, 2023 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dpark01 dpark01 dpark01 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tomkinsc @dpark01