You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2020/12/06 16:18:26 UTC
[libcloud] 05/06: Upgrade to latest version of sphinx.
This is an automated email from the ASF dual-hosted git repository.
tomaz pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/libcloud.git
commit 6fbb029a755041d308623fcf93360f32e7ab3981
Author: Tomaz Muraus <to...@tomaz.me>
AuthorDate: Sun Dec 6 16:58:12 2020 +0100
Upgrade to latest version of sphinx.
---
docs/conf.py | 22 ++++------------------
tox.ini | 4 ++--
2 files changed, 6 insertions(+), 20 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index 617179c..9f9917b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,11 +16,6 @@ import sys
import datetime
import subprocess
-from sphinx.environment import BuildEnvironment
-
-#from sphinx.ext.autodoc import AutodocRegistry
-#from sphinx.ext.autodoc import AutodocReporter
-
from sphinx.domains.python import PythonDomain
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
@@ -274,22 +269,13 @@ texinfo_documents = [
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
-
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
autoclass_content = 'both'
-BuildEnvironment.warn_node = ignore_more_than_one_target_found_errors
-
# Ignore "more than one target found for cross-reference" errors which are false
-# positives
-class PatchedPythonDomain(PythonDomain):
- def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
- if 'refspecific' in node:
- del node['refspecific']
- return super(PatchedPythonDomain, self).resolve_xref(
- env, fromdocname, builder, typ, target, node, contnode)
-
-#def setup(sphinx):
- #sphinx.override_domain(PatchedPythonDomain)
+# non fatal / false positive
+suppress_warnings = [
+ 'ref.python'
+]
diff --git a/tox.ini b/tox.ini
index da48620..350998c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -81,7 +81,7 @@ commands = pip install sphinx==3.3.1
python ../contrib/generate_provider_feature_matrix_table.py
sphinx-apidoc -d 4 ../libcloud/ -o apidocs/
/bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)"
- sphinx-build -b html -d {envtmpdir}/doctrees . _build/html
+ sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:docs-travis]
# Note: We don't build API docs on Travis since it causes build failures because
@@ -96,7 +96,7 @@ commands = pip install sphinx==3.3.1
rstcheck --report warning ../CONTRIBUTING.rst
python ../contrib/generate_provider_feature_matrix_table.py
/bin/bash -c "ls apidocs/modules.rst && (grep orphan apidocs/modules.rst || sed -i '1i :orphan:\n' apidocs/modules.rst) || (exit 0)"
- sphinx-build -b html -d {envtmpdir}/doctrees . _build/html
+ sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html
[testenv:provider-tables]
basepython: python3.7