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

documentation build fixes for ReadTheDocs #450

Merged
merged 21 commits into from
Jan 18, 2023
Merged

documentation build fixes for ReadTheDocs #450

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
8b159c7
pin jinja2<3.1
tomkinsc Jan 18, 2023
e777c0d
override sphinx pinning done by RTD
tomkinsc Jan 18, 2023
9630bd4
(debugging) omit jinja2 pinning
tomkinsc Jan 18, 2023
9039a7b
list jinja2 in requirements but without a version pin
tomkinsc Jan 18, 2023
86dc2b2
set sphinx builder to "html" in the RTD config
tomkinsc Jan 18, 2023
32d10b8
omit sphinx autodoc since this repo is for wdls not pythons
tomkinsc Jan 18, 2023
d930695
Update requirements.txt
tomkinsc Jan 18, 2023
0f68d52
Update requirements.txt
tomkinsc Jan 18, 2023
0203fa7
bump RTD python 3.6->3.8
tomkinsc Jan 18, 2023
d5623ad
comment out wdl_aid import in sphinx config
tomkinsc Jan 18, 2023
e399fcd
try always explicitly specifying the sphinx_rtd_theme
tomkinsc Jan 18, 2023
0e651a2
revert toggle of RTD sphinx theme based on build environment
tomkinsc Jan 18, 2023
aecd7f0
pass through error code on build-docs.sh failure
tomkinsc Jan 18, 2023
b909243
invert
tomkinsc Jan 18, 2023
2331a5d
remove whitespace before sphinx config imports
tomkinsc Jan 18, 2023
a518305
capture and print wdl-aid output upon error
tomkinsc Jan 18, 2023
ca1fd20
pip freeze after installing docs dependencies on GH actions
tomkinsc Jan 18, 2023
0655ee7
bump python to 3.11 for RTD and GH Actions doc builds
tomkinsc Jan 18, 2023
290c689
explicitly pin most of the documentation build requirements
tomkinsc Jan 18, 2023
8327300
roll back python used for doc builds to 3.8
tomkinsc Jan 18, 2023
7e4bd02
add back sphinx autodoc extension
tomkinsc Jan 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Jinja2<3.1
Sphinx
sphinx-argparse
sphinx_rtd_theme
Expand Down