|
32 | 32 | else f"{copyright_first_year}-{current_year}" |
33 | 33 | ) |
34 | 34 | copyright = f"{copyright_year_string}, {copyright_owners}. All rights reserved" |
35 | | - |
36 | | -# The short X.Y version |
37 | 35 | version = "" |
38 | | -# The full version, including alpha/beta/rc tags |
39 | 36 | release = "" |
40 | 37 |
|
41 | | - |
42 | 38 | # -- General configuration --------------------------------------------------- |
43 | 39 |
|
44 | | -# If your documentation needs a minimal Sphinx version, state it here. |
45 | | -# |
46 | | -# needs_sphinx = '1.0' |
47 | | - |
48 | | -# Add any Sphinx extension module names here, as strings. They can be |
49 | | -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
50 | | -# ones. |
51 | 40 | extensions = [ |
52 | 41 | "sphinx.ext.autosummary", |
53 | 42 | "sphinx.ext.autodoc", |
54 | | - "sphinx.ext.mathjax", |
55 | 43 | "sphinx.ext.viewcode", |
56 | 44 | "sphinx.ext.napoleon", |
57 | 45 | "sphinx.ext.intersphinx", |
|
65 | 53 | napoleon_use_param = False |
66 | 54 | napoleon_use_ivar = True |
67 | 55 |
|
68 | | -# Add any paths that contain templates here, relative to this directory. |
69 | | -# templates_path = ["_templates"] |
70 | | - |
71 | | -# The suffix(es) of source filenames. |
72 | | -# You can specify multiple suffix as a list of string: |
73 | | -# |
74 | | -source_suffix = ['.rst', '.md'] |
75 | | -#source_suffix = ".md" |
76 | | - |
77 | | -# The master toctree document. |
| 56 | +source_suffix = [".rst", ".md"] |
78 | 57 | master_doc = "index" |
79 | 58 |
|
80 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
81 | | -# for a list of supported languages. |
82 | | -# |
83 | | -# This is also used if you do content translation via gettext catalogs. |
84 | | -# Usually you set "language" from the command line for these cases. |
85 | 59 | language = "en" |
86 | 60 |
|
87 | | -# List of patterns, relative to source directory, that match files and |
88 | | -# directories to ignore when looking for source files. |
89 | | -# This pattern also affects html_static_path and html_extra_path . |
90 | 61 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
91 | 62 |
|
92 | 63 | # The name of the Pygments (syntax highlighting) style to use. |
93 | 64 | pygments_style = "default" |
94 | 65 |
|
95 | | - |
96 | 66 | # -- Options for HTML output ------------------------------------------------- |
97 | 67 |
|
98 | | -# The theme to use for HTML and HTML Help pages. See the documentation for |
99 | | -# a list of builtin themes. |
100 | | -# |
101 | 68 | html_theme = "furo" |
102 | | -# html_logo = "images/blaah" |
103 | | - |
104 | | -# Theme options are theme-specific and customize the look and feel of a theme |
105 | | -# further. For a list of options available for each theme, see the |
106 | | -# documentation. |
107 | | -# |
108 | | -# html_theme_options = {} |
109 | 69 | html_theme_options = { |
110 | 70 | "light_logo": "ccpbiosim-dark-sq.png", # Your light mode logo file |
111 | 71 | "dark_logo": "ccpbiosim-light-sq.png", # Your dark mode logo file |
112 | 72 | } |
113 | 73 |
|
114 | | -# Add any paths that contain custom static files (such as style sheets) here, |
115 | | -# relative to this directory. They are copied after the builtin static files, |
116 | | -# so a file named "default.css" will overwrite the builtin "default.css". |
117 | 74 | html_static_path = ["_static"] |
118 | 75 |
|
119 | | -# Custom sidebar templates, must be a dictionary that maps document names |
120 | | -# to template names. |
121 | | -# |
122 | | -# The default sidebars (for documents that don't match any pattern) are |
123 | | -# defined by theme itself. Builtin themes are using these templates by |
124 | | -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
125 | | -# 'searchbox.html']``. |
126 | | -# |
127 | | -# html_sidebars = {} |
128 | | - |
129 | | - |
130 | | -# -- Options for HTMLHelp output --------------------------------------------- |
131 | | - |
132 | 76 | # Output file base name for HTML help builder. |
133 | 77 | htmlhelp_basename = "ccpbiosim_doc" |
134 | 78 |
|
135 | | - |
136 | 79 | # -- Options for LaTeX output ------------------------------------------------ |
137 | | - |
138 | | -latex_elements = { |
139 | | - # The paper size ('letterpaper' or 'a4paper'). |
140 | | - # |
141 | | - # 'papersize': 'letterpaper', |
142 | | - # The font size ('10pt', '11pt' or '12pt'). |
143 | | - # |
144 | | - # 'pointsize': '10pt', |
145 | | - # Additional stuff for the LaTeX preamble. |
146 | | - # |
147 | | - # 'preamble': '', |
148 | | - # Latex figure (float) alignment |
149 | | - # |
150 | | - # 'figure_align': 'htbp', |
151 | | -} |
152 | | - |
153 | | -# Grouping the document tree into LaTeX files. List of tuples |
154 | | -# (source start file, target name, title, |
155 | | -# author, documentclass [howto, manual, or own class]). |
| 80 | +latex_elements = {} |
156 | 81 | latex_documents = [ |
157 | 82 | ( |
158 | 83 | master_doc, |
|
163 | 88 | ), |
164 | 89 | ] |
165 | 90 |
|
166 | | - |
167 | 91 | # -- Options for manual page output ------------------------------------------ |
168 | | - |
169 | | -# One entry per manual page. List of tuples |
170 | | -# (source start file, name, description, authors, manual section). |
171 | 92 | man_pages = [(master_doc, "CCPBioSim", "CCPBioSim Developers Documentation", [author], 1)] |
172 | 93 |
|
173 | | - |
174 | 94 | # -- Options for Texinfo output ---------------------------------------------- |
175 | | - |
176 | | -# Grouping the document tree into Texinfo files. List of tuples |
177 | | -# (source start file, target name, title, author, |
178 | | -# dir menu entry, description, category) |
179 | 95 | texinfo_documents = [ |
180 | 96 | ( |
181 | 97 | master_doc, |
|
187 | 103 | ), |
188 | 104 | ] |
189 | 105 |
|
190 | | - |
191 | 106 | # -- Extension configuration ------------------------------------------------- |
192 | 107 | def setup(app): |
193 | 108 | app.add_css_file("custom.css") |
0 commit comments