Fix building of the docs #1886

Merged
g1itch merged 4 commits from doc-fix into v0.6 2021-11-23 19:59:55 +01:00
5 changed files with 18 additions and 8 deletions

View File

@ -6,4 +6,4 @@ python:
- requirements: docs/requirements.txt - requirements: docs/requirements.txt
- method: setuptools - method: setuptools
path: . path: .
system_packages: true system_packages: false

View File

@ -201,8 +201,9 @@ epub_exclude_files = ['search.html']
autodoc_mock_imports = [ autodoc_mock_imports = [
'debug', 'debug',
'pybitmessage.bitmessagekivy', 'pybitmessage.bitmessagekivy',
'pybitmessage.bitmessageqt.addressvalidator', 'pybitmessage.bitmessageqt.foldertree',
'pybitmessage.helper_startup', 'pybitmessage.helper_startup',
'pybitmessage.mock',
'pybitmessage.network.httpd', 'pybitmessage.network.httpd',
'pybitmessage.network.https', 'pybitmessage.network.https',
'ctypes', 'ctypes',
@ -216,9 +217,10 @@ autodoc_mock_imports = [
'pycanberra', 'pycanberra',
'pyopencl', 'pyopencl',
'PyQt4', 'PyQt4',
'pyxdg', 'PyQt5',
'qrcode', 'qrcode',
'stem', 'stem',
'xdg',
] ]
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
@ -227,10 +229,11 @@ apidoc_module_dir = '../pybitmessage'
apidoc_output_dir = 'autodoc' apidoc_output_dir = 'autodoc'
apidoc_excluded_paths = [ apidoc_excluded_paths = [
'bitmessagekivy', 'build_osx.py', 'bitmessagekivy', 'build_osx.py',
'bitmessageqt/addressvalidator.py', 'bitmessageqt/migrationwizard.py', 'bitmessageqt/addressvalidator.py', 'bitmessageqt/foldertree.py',
'bitmessageqt/newaddresswizard.py', 'helper_startup.py', 'bitmessageqt/migrationwizard.py', 'bitmessageqt/newaddresswizard.py',
'kivymd', 'main.py', 'navigationdrawer', 'network/http*', 'helper_startup.py',
'pybitmessage', 'tests', 'version.py' 'kivymd', 'mock', 'main.py', 'navigationdrawer', 'network/http*',
'src', 'tests', 'version.py'
] ]
apidoc_module_first = True apidoc_module_first = True
apidoc_separate_modules = True apidoc_separate_modules = True

View File

@ -1,2 +1,3 @@
m2r m2r
sphinxcontrib-apidoc sphinxcontrib-apidoc
docutils<=0.17.1
g1itch commented 2021-11-22 16:22:06 +01:00 (Migrated from github.com)
Review

Hmm, it seems that actually this hunk fixes the RTD build, not only my local test with tox.

Hmm, it seems that actually this hunk fixes the RTD build, not only my local test with tox.

View File

@ -13,7 +13,7 @@ from src.version import softwareVersion
EXTRAS_REQUIRE = { EXTRAS_REQUIRE = {
'docs': ['sphinx', 'sphinxcontrib-apidoc', 'm2r'], 'docs': ['sphinx', 'sphinx_rtd_theme'],
'gir': ['pygobject'], 'gir': ['pygobject'],
'json': ['jsonrpclib'], 'json': ['jsonrpclib'],
'notify2': ['notify2'], 'notify2': ['notify2'],

View File

@ -12,6 +12,12 @@ commands =
coverage run -a src/bitmessagemain.py -t coverage run -a src/bitmessagemain.py -t
coverage run -a -m tests coverage run -a -m tests
[testenv:py27-doc]
deps =
.[docs]
-r docs/requirements.txt
commands = python setup.py build_sphinx
[testenv:reset] [testenv:reset]
commands = coverage erase commands = coverage erase