11#!/usr/bin/env python
2- # flake8: noqa
32#
43# tiatoolbox documentation build configuration file, created by
54# sphinx-quickstart on Fri Jun 9 13:47:02 2017.
1918# absolute, like shown here.
2019#
2120import os
22- from pathlib import Path
2321import shutil
2422import sys
23+ from pathlib import Path
2524
2625sys .path .insert (0 , os .path .abspath (".." ))
2726
8483
8584# General information about the project.
8685project = "TIA Toolbox"
87- copyright = "2025, TIA Lab"
86+ copyright = "2025, TIA Lab" # noqa: A001
8887author = "TIA Lab"
8988
9089# The version info for the project you're documenting, acts as replacement
140139 "name" : "TIA" ,
141140 "url" : "https://warwick.ac.uk/fac/cross_fac/tia/" ,
142141 "html" : """
143- <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
142+ <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg"
143+ xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
144144 viewBox="0 0 173 175" style="enable-background:new 0 0 173 175;" xml:space="preserve">
145- <image style="overflow:visible;" width="519" height="525" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgcAAAINCAYAAACqOtxdAAABemlDQ1BJQ0MgUHJvZmlsZQAAKJF9
145+ <image style="overflow:visible;" width="519" height="525"
146+ xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgcAAAINCAYAAACqOtxdAAABemlDQ1BJQ0MgUHJvZmlsZQAAKJF9
146147 kE0rRFEYx38GjbxEsbCwuHlbDTFKbJSZNKYsNChvmzvXnRllrtudK2RjoWwVJTbeFnwCNhbKWilF
147148 Sna+ALGRrufMjMZLeeo5z+885zn/zvmDL6Db9lxJB6Qt14lFQtr4xKTmf8KHnxqqqNeNjN0/PDyE
148149 xFf9GW+3FKl606a0/p7/GxUzZsaAojLhPsN2XOFB4aZF11as9OoceZTwquJkjrcUx3N8kp0ZjYWF
18741875 "url" : "https://github.com/TissueImageAnalytics/tiatoolbox" ,
18751876 "html" : """
18761877 <svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle">
1877- <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path>
1878+ <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29
1879+ 6.53 5.47 7.59.4.07.55-.17.55-.38
1880+ 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94
1881+ -.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21
1882+ 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95
1883+ 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21
1884+ 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path>
18781885 </svg>
18791886 """ ,
18801887 "class" : "only-light" ,
19011908html_static_path = []
19021909
19031910# These paths are either relative to html_static_path
1904- # or fully qualified paths (eg. https://...)
1905- # html_css_files = []
1911+ # or fully qualified paths (e.g., https://...)
19061912
19071913# -- Options for HTMLHelp output ---------------------------------------
19081914
19631969 "Sphinx" : ("https://www.sphinx-doc.org/en/stable/" , None ),
19641970}
19651971
1966- # create latex preamble so that we can build arbitrary nested depth
1967- fh = open ("latex_preamble.tex" , "r+" )
1968- PREAMBLE = fh .read ()
1969- fh .close ()
1970- latex_elements = {
1971- # Additional stuff for the LaTeX preamble.
1972- "preamble" : PREAMBLE ,
1973- }
1974-
19751972# -- Options for autodoc -----------------------------------------------
19761973
19771974autodoc_typehints = "description"
19801977 "ArrayLike" : "ArrayLike" ,
19811978}
19821979
1983- print ("=" * 43 )
1980+ print ("=" * 43 ) # noqa: T201
19841981print ("Copy example notebooks into docs/_notebooks" )
1985- print ("=" * 43 )
1982+ print ("=" * 43 ) # noqa: T201
19861983
19871984
19881985def all_but_ipynb (dir_path , contents ):
@@ -2004,13 +2001,8 @@ def all_but_ipynb(dir_path, contents):
20042001 ignore = all_but_ipynb ,
20052002)
20062003
2007- # shutil.copy(
2008- # os.path.join(PROJ_ROOT, "docs/usage_examples.rst"),
2009- # os.path.join(PROJ_ROOT, "docs/_notebooks/usage_examples.rst"),
2010- # )
2011-
20122004# Read in the file
2013- with open ("../examples/README.md" , "r" ) as file :
2005+ with open ("../examples/README.md" ) as file :
20142006 file_data = file .read ()
20152007
20162008# Replace the target string
0 commit comments