Merge pull request #3423 from jtschladen/fix-docs
Fix docs build to include autodoc again
This commit is contained in:
commit
01b880a74b
|
@ -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
|
|
@ -1,7 +1,11 @@
|
||||||
# Note: python-ldap from requirements breaks due to readthedocs.io not having the correct header files
|
# 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
|
# The `make up-reqs` will update all requirement text files, and forcibly remove python-ldap
|
||||||
# from requirements-docs.txt
|
# 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
|
sphinx
|
||||||
sphinxcontrib-httpdomain
|
sphinxcontrib-httpdomain
|
||||||
sphinx-rtd-theme
|
sphinx-rtd-theme
|
||||||
|
|
|
@ -18,6 +18,8 @@ idna==2.9
|
||||||
# via requests
|
# via requests
|
||||||
imagesize==1.2.0
|
imagesize==1.2.0
|
||||||
# via sphinx
|
# via sphinx
|
||||||
|
flask==1.1.2
|
||||||
|
# manual debug
|
||||||
jinja2==2.11.3
|
jinja2==2.11.3
|
||||||
# via sphinx
|
# via sphinx
|
||||||
markupsafe==1.1.1
|
markupsafe==1.1.1
|
||||||
|
|
Loading…
Reference in New Issue