Skip to content

Generate docs with Sphinx #90

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.

Sign up for GitHub

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

Jump to bottom
Closed
tswast opened this issue Mar 23, 2021 · 0 comments · Fixed by #97
Closed

Generate docs with Sphinx #90

tswast opened this issue Mar 23, 2021 · 0 comments · Fixed by #97
Labels
api: bigquery Issues related to the googleapis/python-bigquery-sqlalchemy API. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@tswast
Copy link
Collaborator

tswast commented Mar 23, 2021

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.
@tswast tswast added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. api: bigquery Issues related to the googleapis/python-bigquery-sqlalchemy API. labels Mar 23, 2021
This was referenced Mar 23, 2021
Merged
Merged
Merged
gcf-merge-on-green bot pushed a commit that referenced this issue Mar 25, 2021
@tswast
docs: build documentation with Sphinx (#97)
1707737 
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-bigquery-sqlalchemy/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)

Fixes #90  🦕
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api: bigquery Issues related to the googleapis/python-bigquery-sqlalchemy API. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: build documentation with Sphinx tswast/python-bigquery-sqlalchemy
1 participant
@tswast