Skip to content

Build docs using python3 #1885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
g1itch wants to merge 4 commits into
base: v0.6
Choose a base branch
from
Draft

Build docs using python3 #1885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bedf368
Update autodoc_mock_imports in the docs/conf.py
g1itch Nov 20, 2021
1514975
Adjust docs extra: replace m2r by m2r2
g1itch Nov 20, 2021
eff8faf
Set python.version to 3.8 in the .readthedocs.yml
g1itch Nov 20, 2021
b7993a4
Rename the tox env for building docs for using python3
g1itch Nov 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2

python:
version: 2.7
version: 3.8
install:
- requirements: docs/requirements.txt
- method: setuptools
Expand Down
11 changes: 7 additions & 4 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
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
Expand All @@ -46,7 +46,7 @@
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinxcontrib.apidoc',
'm2r',
'm2r2',
]

default_role = 'obj'
Expand Down Expand Up @@ -199,13 +199,16 @@
# -- 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',
Expand Down Expand Up @@ -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 ----------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
m2r
m2r2
sphinxcontrib-apidoc
docutils<=0.17.1
2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down