Skip to content
This repository has been archived by the owner on Apr 28, 2023. It is now read-only.

Commit

Permalink
Update for sphinx 2.0 and filter warning from sphinx_rtd_theme, pending
Browse files Browse the repository at this point in the history
  • Loading branch information
rhelmot committed Mar 30, 2019
1 parent 6f6b9d5 commit 0bdccd7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 9 deletions.
7 changes: 0 additions & 7 deletions api-doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
import sys
import os

from recommonmark.parser import CommonMarkParser

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand All @@ -40,11 +38,6 @@

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_parsers = {
'.md': CommonMarkParser,
}

source_suffix = ['.rst', '.md']

# The encoding of source files.
Expand Down
4 changes: 2 additions & 2 deletions tests/test_apidoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ def test_lint_docstrings():
p = subprocess.Popen('make html', shell=True, cwd=_path('api-doc'), stderr=subprocess.PIPE)
_, stderr = p.communicate()

# Filter the deprecation warning from the cryptography package
# Filter any warnings we want to be okay with
if stderr:
stderr_lines = stderr.split(b"\n")
stderr = b"\n".join(l for l in stderr_lines if b'MIPS instruction groups' not in l)
stderr = b"\n".join(l for l in stderr_lines if b'sphinx_rtd_theme/search.html:20' not in l and b'{{ super() }}' not in l)

if stderr:
raise Exception("The following warnings were generated while building the API documentation:\n\n%s" % stderr.decode())
Expand Down

0 comments on commit 0bdccd7

Please sign in to comment.