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.

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

Building the docs breaks #19

Closed
HemangChothani opened this issue Apr 20, 2020 · 1 comment
Closed

Building the docs breaks #19

HemangChothani opened this issue Apr 20, 2020 · 1 comment
Assignees
@HemangChothani
Labels
api: bigtable Issues related to the googleapis/python-bigtable API. api: docs Issues related to the Docs API API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@HemangChothani
Copy link
Contributor

I noticed that building the docs locally on master fails due to the following error:

sphinx.errors.SphinxWarning: /python-bigtable/docs/index.rst:27:toctree contains reference to document 'changelog' that doesn't have a title: no link will be generated

It turns out that the issue does not occur with the older version of Sphinx (< 3.x), thus it appears as a bug in the Sphinx package itself. A workaround is to pin that dependency to an older version

/cc @crwilcox
@HemangChothani HemangChothani added api: bigtable Issues related to the googleapis/python-bigtable API. api: docs Issues related to the Docs API API. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Apr 20, 2020
@HemangChothani HemangChothani self-assigned this Apr 20, 2020
@HemangChothani HemangChothani mentioned this issue Apr 20, 2020
Closed
@HemangChothani
Copy link
Contributor Author

Solved from synthtool.

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

@HemangChothani HemangChothani

Labels
api: bigtable Issues related to the googleapis/python-bigtable API. api: docs Issues related to the Docs API API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(bigtable): add parser in extensions of conf.py file MaxxleLLC/python-bigtable
1 participant
@HemangChothani