aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTres Seaver <tseaver@palladion.com>2020-10-06 15:47:28 -0400
committerGitHub <noreply@github.com>2020-10-06 15:47:28 -0400
commit000d0a04b6c539aa6a6aae0a487665341be484c4 (patch)
tree78211580b2db2eb2192c2d8380dd6171175603af /docs
parentdb8e636f545a8872f959e3f403cfec30ffed6c34 (diff)
downloadpython-api-core-000d0a04b6c539aa6a6aae0a487665341be484c4.tar.gz
chore: preserve 'pytype' artifacts during synth (#90)
* chore: use '.pytype' vs. 'pytype_output' for pytype cache * chore: add snippet-bot to CI (via synth) * chore: drop obsolete warning about editable installs * chore: add secrets manager, docs-presubmit to CI (via synth) * chore: manual synth Closes: #66. Closes: #56.
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index a53c37d..2f220a4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -20,12 +20,16 @@ import shlex
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath(".."))
+# For plugins that can not read conf.py.
+# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85
+sys.path.insert(0, os.path.abspath("."))
+
__version__ = ""
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "1.6.3"
+needs_sphinx = "1.5.5"
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -35,6 +39,7 @@ extensions = [
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx",
"sphinx.ext.coverage",
+ "sphinx.ext.doctest",
"sphinx.ext.napoleon",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
@@ -90,7 +95,12 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = ["_build"]
+exclude_patterns = [
+ "_build",
+ "samples/AUTHORING_GUIDE.md",
+ "samples/CONTRIBUTING.md",
+ "samples/snippets/README.rst",
+]
# The reST default role (used for this markup: `text`) to use for all
# documents.