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

Test build to update docs to sphinx 4.x #338

Merged
merged 37 commits into from
Nov 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
b6ca5cc
docs WIP, layout and drift background page
ascillitoe Aug 23, 2021
5624b32
docs WIP 2
ascillitoe Aug 24, 2021
801c69f
docs WIP 3
ascillitoe Aug 27, 2021
b5cfea6
Minor doc fixes
ascillitoe Aug 27, 2021
9025345
Merge branch 'master' of https://github.com/SeldonIO/alibi-detect
ascillitoe Aug 27, 2021
fcc75de
Trigger Build
ascillitoe Aug 27, 2021
da507f4
Minor doc fixes and add doc build to CI
ascillitoe Aug 30, 2021
78a7c2f
Install alibi-detect on CI before building docs
ascillitoe Aug 30, 2021
058c0a0
Install latex during CI
ascillitoe Aug 30, 2021
08feb9d
Crop erroneous pixel from logo
ascillitoe Aug 30, 2021
c0e7fce
Embed images in notebooks and remove install of alibi-detect from doc…
ascillitoe Aug 31, 2021
56c9217
Add explicit pandoc and use latest docker image with Python 3.8 for r…
jklaise Sep 1, 2021
bbf164f
CI docker test
ascillitoe Sep 1, 2021
852c141
WIP
ascillitoe Sep 1, 2021
32a4b1e
WIP
ascillitoe Sep 1, 2021
b3912eb
Try RTD 5.0 docker image
ascillitoe Sep 1, 2021
4a2dcb5
Fix use of docker image in ci.yml
ascillitoe Sep 1, 2021
b756151
Set user id
ascillitoe Sep 1, 2021
213341b
try as root
ascillitoe Sep 1, 2021
d2eef76
use pip3
ascillitoe Sep 1, 2021
13c38e9
Fix embedded images
ascillitoe Sep 1, 2021
290f28a
Update background page
ascillitoe Sep 2, 2021
0cc72a5
Merged master with feature_docs
ascillitoe Sep 2, 2021
aa170d6
Added learnedkernel and spotthediff method notebooks
ascillitoe Sep 2, 2021
ba7ad7e
WIP
ascillitoe Sep 2, 2021
cd05e9b
Corrections to comments, and learned section.
ascillitoe Sep 13, 2021
df90412
Rewrite to .rst file. Fallback to png for latex build
ascillitoe Sep 15, 2021
29f28c4
Move to myst files. Initial RTD test
ascillitoe Sep 16, 2021
451d973
merged master into feature_docs
ascillitoe Sep 16, 2021
52fa664
Moved doctrees output to doc/_build
ascillitoe Sep 16, 2021
45c4670
Update to sphinx 4.x. Api docs problem with Bases
ascillitoe Sep 17, 2021
12679a9
Merge in master
ascillitoe Nov 1, 2021
0a20739
Fix requirements/docs.txt merge
ascillitoe Nov 1, 2021
b127712
Fixed landing.md
ascillitoe Nov 1, 2021
1806dfc
Removed surplus line in landing.md
ascillitoe Nov 1, 2021
a22fdef
Add line in conf.py
ascillitoe Nov 1, 2021
98b73a8
Remove repeated docs/requirements.txt entry
ascillitoe Nov 1, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 14 additions & 16 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
html_static_path = ["_static"]

# override default theme width
html_context = {"css_files": ["_static/theme_overrides.css"]} # override wide tables in RTD theme
html_css_files = ['theme_overrides.css'] # override wide tables in RTD theme

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down Expand Up @@ -317,18 +317,16 @@
# Create heading anchors for h1 to h3 (useful for local toc's)
myst_heading_anchors = 3

## -- Decorators patch --------------------------------------------------------
## Below code fixes a problem with sphinx>=3.2.0 processing functions with
## torch.jit.script decorator. Probably occuring because torch is being mocked
## (see https://github.com/sphinx-doc/sphinx/issues/6709).
## Strangely should be fixed by sphinx #6719 (>=v2.3.0), but doesn't appear to
## be for us...
#def call_mock(self, *args, **kw):
# from types import FunctionType, MethodType
# if args and type(args[0]) in [type, FunctionType, MethodType]:
# # Appears to be a decorator, pass through unchanged
# return args[0]
# return self
#
#from sphinx.ext.autodoc.mock import _MockObject
#_MockObject.__call__ = call_mock
# Below code fixes a problem with sphinx>=3.2.0 processing functions with
# torch.jit.script decorator. Probably occuring because torch is being mocked
# (see https://github.com/sphinx-doc/sphinx/issues/6709).
def call_mock(self, *args, **kw):
from types import FunctionType, MethodType
if args and type(args[0]) in [type, FunctionType, MethodType]:
# Appears to be a decorator, pass through unchanged
return args[0]
return self

from sphinx.ext.autodoc.mock import _MockObject
_MockObject.__call__ = call_mock

8 changes: 4 additions & 4 deletions requirements/docs.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# dependencies for building docs, separate from dev.txt as this is also used for builds on readthedocs.org
# core dependencies
sphinx>=2.1.2, <3.0.0 # pin to <3.x due to issue documenting classes which inherit mocked classes
sphinx-autodoc-typehints>=1.6.0, <1.13.0 # later versions depend on sphinx 3.0
sphinx-rtd-theme>=0.5.2, <0.6.0
sphinx>=4.2.0, <5.0.0
sphinx-autodoc-typehints>=1.12.0, <=2.0.0
sphinx-rtd-theme>=1.0.0, <=2.0.0
sphinxcontrib-apidoc>=0.3.0, <0.4.0
myst-parser>=0.14, <=0.15.2
myst-parser>=0.14, <0.16
nbsphinx>=0.8.5, <0.9.0
nbsphinx-link>=1.2.0, <2.0.0
ipykernel>=5.1.0, <6.0.0 # required for executing notebooks via nbsphinx
Expand Down