Skip to content
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.

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

Spanner: Building the docs fails #10099

Closed
plamut opened this issue Jan 10, 2020 · 0 comments · Fixed by #10106
Closed

Spanner: Building the docs fails #10099

plamut opened this issue Jan 10, 2020 · 0 comments · Fixed by #10106
Assignees
Labels
api: spanner Issues related to the Spanner API. type: docs Improvement to the documentation for an API.

Comments

@plamut
Copy link
Contributor

plamut commented Jan 10, 2020

Building the docs emits a warning, which is interpreted as error:

$ nox -f noxfile.py -s docs

...
Traceback (most recent call last):
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app.build(args.force_all, filenames)
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/application.py", line 353, in build
    self.builder.build_update()
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 299, in build_update
    len(to_build))
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 361, in build
    self.write(docnames, list(updated_docnames), method)
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 535, in write
    self._write_serial(sorted(docnames))
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 545, in _write_serial
    self.write_doc(docname, doctree)
  File "/usr/local/lib/python3.7/contextlib.py", line 119, in __exit__
    next(self.gen)
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/util/logging.py", line 219, in pending_warnings
    memhandler.flushTo(logger)
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/util/logging.py", line 184, in flushTo
    logger.handle(record)
  File "/usr/local/lib/python3.7/logging/__init__.py", line 1478, in handle
    self.callHandlers(record)
  File "/usr/local/lib/python3.7/logging/__init__.py", line 1540, in callHandlers
    hdlr.handle(record)
  File "/usr/local/lib/python3.7/logging/__init__.py", line 850, in handle
    rv = self.filter(record)
  File "/usr/local/lib/python3.7/logging/__init__.py", line 712, in filter
    result = f.filter(record)
  File "/home/peter/workspace/google-cloud-python/spanner/.nox/docs/lib/python3.7/site-packages/sphinx/util/logging.py", line 404, in filter
    raise SphinxWarning(location + ":" + message)
sphinx.errors.SphinxWarning: /home/peter/workspace/google-cloud-python/spanner/docs/instance-api.rst:11:Could not lex literal_block as "python". Highlighting skipped.
@plamut plamut added api: spanner Issues related to the Spanner API. type: process A process-related concern. May include testing, release, or the like. type: docs Improvement to the documentation for an API. labels Jan 10, 2020
@busunkim96 busunkim96 removed the type: process A process-related concern. May include testing, release, or the like. label Jan 10, 2020
@IlyaFaer IlyaFaer self-assigned this Jan 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: spanner Issues related to the Spanner API. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants