Skip to content

Commit 2abd372

Browse files
committed
FIX: updated requirements for env sphinx theme + testing ci sphinx
1 parent 98da1b5 commit 2abd372

File tree

8 files changed

+8
-106
lines changed

8 files changed

+8
-106
lines changed
File renamed without changes.

doc/conf.py

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,17 @@
8383
# Add any Sphinx extension module names here, as strings. They can be
8484
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
8585
# ones.
86-
sys.path.append(os.path.abspath('sphinxext'))
8786
extensions = [
8887
'sphinx.ext.autodoc',
8988
'sphinx.ext.autosummary',
9089
'sphinx.ext.intersphinx',
9190
'sphinx.ext.linkcode',
9291
'sphinx.ext.mathjax',
9392
'sphinx.ext.napoleon',
94-
# 'matplotlib.sphinxext.plot_directive',
9593
'myst_nb',
9694
"sphinx_remove_toctrees",
9795
'sphinx_copybutton',
98-
'jax_extensions',
9996
'sphinx_design',
100-
'sphinxext.rediraffe',
10197
'sphinxcontrib.mermaid',
10298
'sphinx_autodoc_typehints',
10399

@@ -192,24 +188,22 @@
192188
'navigation_with_keys': False,
193189
}
194190

195-
# The name of an image file (relative to this directory) to place at the top
196-
# of the sidebar.
197-
html_logo = './_static/logo_sphinx.png'
198-
199-
# html_favicon = '_static/favicon.png'
200-
html_favicon = '../favicon.png'
201-
202-
203191
# Add any paths that contain custom
204192
# static files (such as style sheets) here,
205193
# relative to this directory. They are copied after the builtin static files,
206194
# so a file named "default.css" will overwrite the builtin "default.css".
207195
html_static_path = ['_static']
208196

197+
# The name of an image file (relative to this directory) to place at the top
198+
# of the sidebar.
199+
html_logo = '_static/logo_sphinx.png'
200+
html_favicon = '_static/logo_favicon.ico'
201+
209202
html_css_files = [
210203
'style.css',
211204
]
212205

206+
213207
# Custom sidebar templates, must be a dictionary that maps document names
214208
# to template names.
215209
#
@@ -231,26 +225,6 @@
231225
# Notebook cell execution timeout; defaults to 30.
232226
nb_execution_timeout = 100
233227

234-
# # List of patterns, relative to source directory, that match notebook
235-
# # files that will not be executed.
236-
# nb_execution_excludepatterns = [
237-
# # Slow notebook: long time to load tf.ds
238-
# 'notebooks/neural_network_with_tfds_data.*',
239-
# # Slow notebook
240-
# 'notebooks/Neural_Network_and_Data_Loading.*',
241-
# # Has extra requirements: networkx, pandas, pytorch, tensorflow, etc.
242-
# 'jep/9407-type-promotion.*',
243-
# # TODO(jakevdp): enable execution on the following if possible:
244-
# 'notebooks/Distributed_arrays_and_automatic_parallelization.*',
245-
# 'notebooks/autodiff_remat.*',
246-
# # Requires accelerators
247-
# 'pallas/quickstart.*',
248-
# 'pallas/tpu/pipelining.*',
249-
# 'pallas/tpu/matmul.*',
250-
# 'sharded-computation.*',
251-
# 'distributed_data_loading.*'
252-
# ]
253-
254228
# -- Options for HTMLHelp output ---------------------------------------------
255229

256230
# Output file base name for HTML help builder.
@@ -365,8 +339,4 @@ def linkcode_resolve(domain, info):
365339
return None
366340
filename = os.path.relpath(filename, start=os.path.dirname(diffCheck.__file__))
367341
lines = f"#L{linenum}-L{linenum + len(source)}" if linenum else ""
368-
return f"https://github.com/diffCheckOrg/diffCheck/blob/main/diffCheck/{filename}{lines}"
369-
370-
371-
# FIXME: this is a temporary fix to suppress redirects warn on console build
372-
rediraffe_redirects = "redirects.txt"
342+
return f"https://github.com/diffCheckOrg/diffCheck/blob/main/diffCheck/{filename}{lines}"

doc/redirects.txt

Whitespace-only changes.

doc/sphinxext/jax_extensions.py

Lines changed: 0 additions & 68 deletions
This file was deleted.
-1.58 MB
Binary file not shown.

environment.yml

16 Bytes
Binary file not shown.

favicon.ico

16.1 KB
Binary file not shown.

tasks.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ def yakerize(c):
6363

6464
@task
6565
def documentize(c):
66-
subprocess.run("conda activate diff_check && sphinx-build doc _build", shell=True, check=True)
66+
subprocess.run("conda activate diff_check && sphinx-build -b html -v doc _build", shell=True, check=True)

0 commit comments

Comments
 (0)