From bedf36801e541af16600326f701d4a91688f723b Mon Sep 17 00:00:00 2001 From: Dmitri Bogomolov <4glitch@gmail.com> Date: Sat, 20 Nov 2021 19:07:33 +0200 Subject: [PATCH 1/4] Update autodoc_mock_imports in the docs/conf.py --- docs/conf.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e3eef6b3..6ca6c872 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,7 @@ copyright = u'2019, The Bitmessage Team' # pylint: disable=redefined-builtin author = u'The Bitmessage Team' # The short X.Y version -version = unicode(version.softwareVersion) +version = version.softwareVersion # The full version, including alpha/beta/rc tags release = version @@ -46,7 +46,7 @@ extensions = [ 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinxcontrib.apidoc', - 'm2r', + 'm2r2', ] default_role = 'obj' @@ -199,13 +199,16 @@ epub_exclude_files = ['search.html'] # -- Extension configuration ------------------------------------------------- autodoc_mock_imports = [ - 'debug', 'pybitmessage.bitmessagekivy', 'pybitmessage.bitmessageqt.foldertree', + 'pybitmessage.bitmessageqt.tests', + 'pybitmessage.debug', + 'pybitmessage.fallback.umsgpack', 'pybitmessage.helper_startup', 'pybitmessage.mock', 'pybitmessage.network.httpd', 'pybitmessage.network.https', + 'pybitmessage.pyelliptic.tests', 'ctypes', 'dialog', 'gi', @@ -268,7 +271,7 @@ def linkcode_resolve(domain, info): # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/2.7/': None} +intersphinx_mapping = {'https://docs.python.org/3/': None} # -- Options for todo extension ---------------------------------------------- -- 2.45.1 From 15149752ce127b8a76173b8b6387306f1517f5da Mon Sep 17 00:00:00 2001 From: Dmitri Bogomolov <4glitch@gmail.com> Date: Sat, 20 Nov 2021 22:39:48 +0200 Subject: [PATCH 2/4] Adjust docs extra: replace m2r by m2r2 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index a62bf415..4bd6ff2d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ -m2r +m2r2 sphinxcontrib-apidoc docutils<=0.17.1 -- 2.45.1 From eff8faf4d1818c3714a2d73d26ea19cd80902d23 Mon Sep 17 00:00:00 2001 From: Dmitri Bogomolov <4glitch@gmail.com> Date: Sat, 20 Nov 2021 22:48:01 +0200 Subject: [PATCH 3/4] Set python.version to 3.8 in the .readthedocs.yml --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 2c7b9839..0fbb9dba 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,7 +1,7 @@ version: 2 python: - version: 2.7 + version: 3.8 install: - requirements: docs/requirements.txt - method: setuptools -- 2.45.1 From b7993a4b55ecda234a68ede800d1f255204645e1 Mon Sep 17 00:00:00 2001 From: Dmitri Bogomolov <4glitch@gmail.com> Date: Sun, 21 Nov 2021 19:03:29 +0200 Subject: [PATCH 4/4] Rename the tox env for building docs for using python3 --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 632c7381..8732af86 100644 --- a/tox.ini +++ b/tox.ini @@ -12,7 +12,7 @@ commands = coverage run -a src/bitmessagemain.py -t coverage run -a -m tests -[testenv:py27-doc] +[testenv:doc] deps = .[docs] -r docs/requirements.txt -- 2.45.1