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

fix broken API docs #1587

Merged
merged 7 commits into from
Oct 6, 2020
Merged

fix broken API docs #1587

merged 7 commits into from
Oct 6, 2020

Conversation

st--
Copy link
Member

@st-- st-- commented Oct 5, 2020

The recent PR for compatibility with multiple tfp versions (#1553, updated by #1574) broke our Sphinx build: we set autodoc_mock_imports = ["tensorflow", "tensorflow_probability"] in doc/source/conf.py; this means when building the documentation, tfp is a mock, and tfp.__version__ cannot be parsed and Version(tfp.__version__) errors! This PR moves the version checks inside reset_cache_bijectors, so there won't be an import-time error anymore (and Sphinx does not actually execute the code).

A few minor fly-by changes that I uncovered in preparing this PR...

@st-- st-- mentioned this pull request Oct 5, 2020
@st-- st-- linked an issue Oct 5, 2020 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Oct 5, 2020

Codecov Report

Merging #1587 into develop will not change coverage.
The diff coverage is 58.33%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1587   +/-   ##
========================================
  Coverage    95.13%   95.13%           
========================================
  Files           86       86           
  Lines         3845     3845           
========================================
  Hits          3658     3658           
  Misses         187      187           
Impacted Files Coverage Δ
gpflow/utilities/utilities.py 91.07% <58.33%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8dc912e...ed8d3b2. Read the comment docs.

@st-- st-- added the bug label Oct 5, 2020
@st-- st-- merged commit 98f7997 into develop Oct 6, 2020
@st-- st-- deleted the st/fix_api_docs branch October 6, 2020 13:30
This was referenced Oct 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API docs are broken
2 participants