From 42044e99aef1a55b5e759e11f29e60670484d7cc Mon Sep 17 00:00:00 2001 From: Jasmine Schladen Date: Tue, 16 Feb 2021 18:07:37 -0800 Subject: [PATCH 1/3] Attempt to fix docs build --- requirements-docs.in | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/requirements-docs.in b/requirements-docs.in index f025a85d..e0df9714 100644 --- a/requirements-docs.in +++ b/requirements-docs.in @@ -1,7 +1,11 @@ # Note: python-ldap from requirements breaks due to readthedocs.io not having the correct header files # The `make up-reqs` will update all requirement text files, and forcibly remove python-ldap # from requirements-docs.txt -# However, dependabot doesn't use `make up-reqs`, so `-r requirements.txt` has been removed completely. +# However, dependabot doesn't use `make up-reqs`, so we have to replicate the necessary dependencies here +# Without including these dependencies, the docs are unable to include generated autodocs +Flask + +# docs specific sphinx sphinxcontrib-httpdomain sphinx-rtd-theme From 8cabffcb70d4f9b3553a883a21cc162b1ffd1f81 Mon Sep 17 00:00:00 2001 From: Jasmine Schladen Date: Tue, 16 Feb 2021 18:13:04 -0800 Subject: [PATCH 2/3] Attempt to fix docs build --- requirements-docs.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements-docs.txt b/requirements-docs.txt index 2e76e73f..c33a9f9f 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -18,6 +18,8 @@ idna==2.9 # via requests imagesize==1.2.0 # via sphinx +flask==1.1.2 + # manual debug jinja2==2.11.3 # via sphinx markupsafe==1.1.1 From e607210fe9a8157ad05b6ac737fd2247e39e1736 Mon Sep 17 00:00:00 2001 From: Jasmine Schladen Date: Tue, 16 Feb 2021 18:22:07 -0800 Subject: [PATCH 3/3] Add .readthedocs.yml file --- .readthedocs.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..54eb8741 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,22 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Build docs in all formats (html, pdf, epub) +formats: all + +# Set the version of Python and requirements required to build the docs +python: + version: 3.7 + install: + - requirements: requirements-docs.txt + - method: setuptools + path: . + system_packages: true \ No newline at end of file