Skip to content

Generate docs with Sphinx #90

Closed
@tswast

Description

@tswast

Docs session is currently failing

nox > Running session docs
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/docs
nox > pip install -e .
nox > pip install sphinx alabaster recommonmark
nox > sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/
Running Sphinx v3.5.3
making output directory... done
[autosummary] generating autosummary for: multiprocessing.rst
loading intersphinx inventory from https://python.readthedocs.org/en/latest/objects.inv...
loading intersphinx inventory from https://googleapis.dev/python/google-auth/latest/objects.inv...
loading intersphinx inventory from https://googleapis.dev/python/google-api-core/latest/objects.inv...
loading intersphinx inventory from https://grpc.github.io/grpc/python/objects.inv...
loading intersphinx inventory from https://proto-plus-python.readthedocs.io/en/latest/objects.inv...
intersphinx inventory has moved: https://python.readthedocs.org/en/latest/objects.inv -> https://python.readthedocs.io/en/latest/objects.inv
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] multiprocessing


Traceback (most recent call last):
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/cmd/build.py", line 280, in build_main
    app.build(args.force_all, filenames)
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/application.py", line 352, in build
    self.builder.build_update()
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 296, in build_update
    self.build(to_build,
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 310, in build
    updated_docnames = set(self.read())
  File "/Users/swast/src/pybigquery/.nox/docs/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 420, in read
    raise SphinxError('master file %s not found' %
sphinx.errors.SphinxError: master file /Users/swast/src/pybigquery/docs/index.rst not found

Sphinx error:
master file /Users/swast/src/pybigquery/docs/index.rst not found
nox > Command sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/ failed with exit code 2
nox > Session docs failed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    api: bigqueryIssues related to the googleapis/python-bigquery-sqlalchemy API.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions