Skip to content

Instantly share code, notes, and snippets.

@amyreese
Created May 12, 2019 03:15
Show Gist options
  • Save amyreese/a6adf9e5dca020dd77080a08448fe952 to your computer and use it in GitHub Desktop.
Save amyreese/a6adf9e5dca020dd77080a08448fe952 to your computer and use it in GitHub Desktop.
CircuitPython docs build failure
(.venv) jreese@legion ~/workspace/circuitpython docs-reqs± » make html
sphinx-build -b html -d _build/doctrees -c . -E -v . _build/html
Running Sphinx v2.0.1
/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/util/compat.py:33: RemovedInSphinx30Warni
ng: The config variable "source_parsers" is deprecated. Please use app.add_source_parser() API instead.
RemovedInSphinx30Warning)
/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/util/compat.py:37: RemovedInSphinx30Warni
ng: app.add_source_parser() does not support suffix argument. Use app.add_source_suffix() instead.
app.add_source_parser(suffix, parser)
/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/util/compat.py:37: RemovedInSphinx30Warni
ng: Old source_parser has been detected. Please fill Parser.supported attribute: CStrip
app.add_source_parser(suffix, parser)
loading intersphinx inventory from https://circuitpython.readthedocs.io/projects/register/en/latest/objects.inv...
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://circuitpython.readthedocs.io/projects/busdevice/en/latest/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 151 source files that are out of date
updating environment: 151 added, 0 changed, 0 removed
reading sources... [ 0%] CODE_OF_CONDUCT
/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/recommonmark/parser.py:65: UserWarning: Container node skipped: type=document
warn("Container node skipped: type={0}".format(mdnode.t))
reading sources... [ 1%] CONTRIBUTING
reading sources... [ 1%] README
reading sources... [ 2%] docs/common_hal
reading sources... [ 3%] docs/design_guide
reading sources... [ 3%] docs/drivers
reading sources... [ 4%] docs/index
reading sources... [ 5%] docs/library/array
reading sources... [ 5%] docs/library/binascii
reading sources... [ 6%] docs/library/btree
reading sources... [ 7%] docs/library/builtins
reading sources... [ 7%] docs/library/collections
reading sources... [ 8%] docs/library/esp
reading sources... [ 9%] docs/library/framebuf
reading sources... [ 9%] docs/library/gc
reading sources... [ 10%] docs/library/hashlib
reading sources... [ 11%] docs/library/index
reading sources... [ 11%] docs/library/micropython
reading sources... [ 12%] docs/library/network
reading sources... [ 13%] docs/library/sys
reading sources... [ 13%] docs/library/uctypes
reading sources... [ 14%] docs/library/uerrno
reading sources... [ 15%] docs/library/uheapq
reading sources... [ 15%] docs/library/uio
reading sources... [ 16%] docs/library/ujson
reading sources... [ 17%] docs/library/ure
reading sources... [ 17%] docs/library/uselect
reading sources... [ 18%] docs/library/usocket
reading sources... [ 19%] docs/library/ussl
reading sources... [ 19%] docs/library/uzlib
reading sources... [ 20%] docs/porting
reading sources... [ 21%] docs/supported_ports
reading sources... [ 21%] docs/troubleshooting
reading sources... [ 22%] license
reading sources... [ 23%] ports/atmel-samd/README
reading sources... [ 23%] ports/atmel-samd/bindings/samd/Clock
Traceback (most recent call last):
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/cmd/build.py", line 284, in build_main
app.build(args.force_all, filenames)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/application.py", line 337, in build
self.builder.build_update()
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 326,
in build_update
len(to_build))
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 339,
in build
updated_docnames = set(self.read())
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 445,
in read
self._read_serial(docnames)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 467,
in _read_serial
self.read_doc(docname)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 511,
in read_doc
doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/io.py", line 323, in read_doc
pub.publish()
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/docutils/core.py", line 217, in publish
self.settings)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/io.py", line 116, in read
self.parse()
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/docutils/readers/__init__.py", line 78,
in parse
self.parser.parse(self.input, document)
File "/Users/jreese/workspace/circuitpython/docs/c2rst.py", line 19, in parse
self.rst_parser.parse(stripped, document)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/parsers.py", line 93, in parse
self.decorate(inputlines)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/parsers.py", line 100, in decorate
prepend_prolog(content, self.config.rst_prolog)
AttributeError: 'RSTParser' object has no attribute 'config'
Exception occurred:
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/parsers.py", line 100, in decorate
prepend_prolog(content, self.config.rst_prolog)
AttributeError: 'RSTParser' object has no attribute 'config'
The full traceback has been saved in /var/folders/n4/mcprf19s35n55sy9gdsds8r00000gn/T/sphinx-err-bgs08srb.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [html] Error 2
(.venv) jreese@legion ~/workspace/circuitpython docs-reqs± ‹2› » cat /var/folders/n4/mcprf19s35n55sy9gdsds8r00000gn/T/sphinx-err-bgs08srb.log
# Sphinx version: 2.0.1
# Python version: 3.5.6 (CPython)
# Docutils version: 0.14
# Jinja2 version: 2.10.1
# Last messages:
# reading sources... [ 21%] docs/supported_ports
#
# reading sources... [ 21%] docs/troubleshooting
#
# reading sources... [ 22%] license
#
# reading sources... [ 23%] ports/atmel-samd/README
#
# reading sources... [ 23%] ports/atmel-samd/bindings/samd/Clock
#
# Loaded extensions:
# sphinx.ext.todo (2.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/ext/todo.py
# sphinx.ext.mathjax (2.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/ext/mathjax.py
# alabaster (0.7.12) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/alabaster/__init__.py
# sphinxcontrib.htmlhelp (1.0.2) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinxcontrib/htmlhelp/__init__.py
# sphinx.ext.coverage (2.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/ext/coverage.py
# sphinxcontrib.qthelp (1.0.2) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinxcontrib/qthelp/__init__.py
# sphinxcontrib.devhelp (1.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinxcontrib/devhelp/__init__.py
# sphinxcontrib.serializinghtml (1.1.3) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinxcontrib/serializinghtml/__init__.py
# sphinx.ext.intersphinx (2.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/ext/intersphinx.py
# sphinx.ext.doctest (2.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/ext/doctest.py
# sphinxcontrib.applehelp (1.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinxcontrib/applehelp/__init__.py
# sphinx.ext.autodoc (2.0.1) from /Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/ext/autodoc/__init__.py
Traceback (most recent call last):
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/cmd/build.py", line 284, in build_main
app.build(args.force_all, filenames)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/application.py", line 337, in build
self.builder.build_update()
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 326, in build_update
len(to_build))
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 339, in build
updated_docnames = set(self.read())
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 445, in read
self._read_serial(docnames)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 467, in _read_serial
self.read_doc(docname)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 511, in read_doc
doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/io.py", line 323, in read_doc
pub.publish()
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/docutils/core.py", line 217, in publish
self.settings)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/io.py", line 116, in read
self.parse()
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/docutils/readers/__init__.py", line 78, in parse
self.parser.parse(self.input, document)
File "/Users/jreese/workspace/circuitpython/docs/c2rst.py", line 19, in parse
self.rst_parser.parse(stripped, document)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/parsers.py", line 93, in parse
self.decorate(inputlines)
File "/Users/jreese/workspace/circuitpython/.venv/lib/python3.5/site-packages/sphinx/parsers.py", line 100, in decorate
prepend_prolog(content, self.config.rst_prolog)
AttributeError: 'RSTParser' object has no attribute 'config'
@elvis-epx
Copy link

Same here.

@amyreese
Copy link
Author

amyreese commented May 24, 2019

Same here.

FYI: the fix for this issue was to be sure to install the correct (older) version of Sphinx. The docs/requirements.txt in circuitpython/master should now reference the correct versions.

@elvis-epx
Copy link

elvis-epx commented May 24, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment