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

Miscellaneous fixes #939

Merged
merged 6 commits into from
Jan 14, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update sphinx version used to generate docs
Signed-off-by: Keith Battocchi <kebatt@microsoft.com>
kbattocchi committed Jan 11, 2025

Unverified

The email in this signature doesn’t match the committer email.
commit dcf516fef1a00060efe8685d76302c014fa7e847
4 changes: 2 additions & 2 deletions .github/workflows/publish-documentation.yml
Original file line number Diff line number Diff line change
@@ -79,14 +79,14 @@ jobs:
- name: Install graphviz
run: sudo apt-get -yq install graphviz
- name: Build documentation
run: pip install "sphinx~=4.4.0" "sphinx_rtd_theme~=1.0.0" && python setup.py build_sphinx -W
run: pip install "sphinx~=7.0" "sphinx_rtd_theme~=2.0.0" && sphinx-build ./doc/ ./build/sphinx/html/ -W
- name: Upload docs as artifact
uses: actions/upload-artifact@v4
with:
name: docs
path: build/sphinx/html/
- name: Run doctests
run: python setup.py build_sphinx -b doctest
run: sphinx-build ./doc/ ./build/sphinx/doctest/ -b doctest
if : ${{ inputs.run_doctests }}

publish-docs:
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
@@ -231,7 +231,7 @@
'sklearn': ('https://scikit-learn.org/1.5/', None),
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though this PR enables support for sklearn 1.6, that doesn't help here because our docs still build on Python 3.8 (because of the tensorflow dependency for Deep IV), where sklearn 1.5 is the latest version.

We need to specifically link to this version of the sklearn docs because there was a change in the structure of their docs between 1.5 and 1.6, so the mismatch between what we were building against vs. what we were linking to was causing broken links.

'matplotlib': ('https://matplotlib.org/stable/', None),
'shap': ('https://shap.readthedocs.io/en/stable/', None),
'dowhy': ('https://www.pywhy.org/dowhy/v0.8/', None),
'dowhy': ('https://www.pywhy.org/dowhy/main/', None),
'statsmodels': ('https://www.statsmodels.org/stable/', None)}