Skip to content
This repository was archived by the owner on May 6, 2022. It is now read-only.

Commit ea222ca

Browse files
authored
Readthedocs Build Update (#46)
This commit fixes various build issues with the autodocs. One change was also made to setup.py based on a readthedocs [recommendation](https://docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules)
1 parent 915c2f1 commit ea222ca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2845
-977
lines changed

.gitmodules

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[submodule "spokestack/extensions/webrtc/filter_audio"]
2-
path = spokestack/extensions/webrtc/filter_audio
3-
url = git@github.com:irungentoo/filter_audio.git
2+
path = spokestack/extensions/webrtc/filter_audio
3+
url = https://github.com/irungentoo/filter_audio.git

.readthedocs.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,24 @@
55
# Required
66
version: 2
77

8+
submodules:
9+
include: all
10+
recursive: True
811
# Build documentation in the docs/ directory with Sphinx
912
sphinx:
1013
configuration: docs/source/conf.py
1114

1215
formats:
13-
- html
16+
- htmlzip
1417

1518
# Optionally set the version of Python and requirements required to build your docs
1619
python:
17-
version: 3.7
20+
version: 3.8
1821
install:
22+
- requirements: docs/requirements.txt
1923
- method: pip
2024
path: .
21-
- requirements: docs/requirements.txt
25+
system_packages: true
26+
2227
build:
2328
image: latest

docs/requirements.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
# This file is autogenerated by pip-compile
33
# To update, run:
44
#
5-
# pip-compile
5+
# pip-compile --output-file=./docs/requirements.txt ./docs/requirements.in
66
#
77
alabaster==0.7.12 # via sphinx
88
argh==0.26.2 # via sphinx-autobuild
99
babel==2.8.0 # via sphinx
1010
certifi==2020.6.20 # via requests
1111
chardet==3.0.4 # via requests
12+
Cython
1213
docutils==0.16 # via sphinx
1314
idna==2.10 # via requests
1415
imagesize==1.2.0 # via sphinx
@@ -26,20 +27,19 @@ pyyaml==5.3.1 # via sphinx-autobuild
2627
requests==2.24.0 # via sphinx
2728
six==1.15.0 # via livereload, packaging, pockets, sphinxcontrib-napoleon
2829
snowballstemmer==2.0.0 # via sphinx
29-
sphinx==3.1.2 # via -r requirements.in, sphinx-autodoc-typehints, sphinx-rtd-theme
30-
sphinx-autobuild==0.7.1 # via -r requirements.in
31-
sphinx-autodoc-typehints==1.11.0 # via -r requirements.in
32-
sphinx-rtd-theme==0.5.0 # via -r requirements.in
30+
sphinx==3.1.2 # via -r ./docs/requirements.in, sphinx-autodoc-typehints, sphinx-rtd-theme
31+
sphinx-autobuild==0.7.1 # via -r ./docs/requirements.in
32+
sphinx-autodoc-typehints==1.11.0 # via -r ./docs/requirements.in
33+
sphinx-rtd-theme==0.5.0 # via -r ./docs/requirements.in
3334
sphinxcontrib-applehelp==1.0.2 # via sphinx
3435
sphinxcontrib-devhelp==1.0.2 # via sphinx
3536
sphinxcontrib-htmlhelp==1.0.3 # via sphinx
3637
sphinxcontrib-jsmath==1.0.1 # via sphinx
37-
sphinxcontrib-napoleon==0.7 # via -r requirements.in
38+
sphinxcontrib-napoleon==0.7 # via -r ./docs/requirements.in
3839
sphinxcontrib-qthelp==1.0.3 # via sphinx
3940
sphinxcontrib-serializinghtml==1.1.4 # via sphinx
4041
tornado==6.0.4 # via livereload, sphinx-autobuild
4142
urllib3==1.25.10 # via requests
4243
watchdog==0.10.3 # via sphinx-autobuild
43-
4444
# The following packages are considered to be unsafe in a requirements file:
4545
# setuptools
3.34 KB
Binary file not shown.
15.3 KB
Binary file not shown.
17.2 KB
Binary file not shown.
12.6 KB
Binary file not shown.
3.21 KB
Binary file not shown.
780 Bytes
Binary file not shown.
-26.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)