Skip to content

Commit 1153c80

Browse files
committed
General doc generation improvements and logo fix
1 parent 3d70bc1 commit 1153c80

File tree

4 files changed

+18
-12
lines changed

4 files changed

+18
-12
lines changed

docs/_static/siibra-python.jpeg

56.2 KB
Loading

docs/_static/siibra.css

+7-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ h1.logo {
88
display: none;
99
}
1010

11+
.wy-side-nav-search .wy-dropdown > a img.logo, .wy-side-nav-search > a img.logo {
12+
width: 300px;
13+
}
14+
.version{
15+
color:rgb(0, 0, 0) !important;
16+
}
17+
1118
.sphx-glr-thumbcontainer {
1219
min-height: 2px !important;
1320
width: 100% !important;
@@ -27,7 +34,6 @@ h1.logo {
2734
}
2835
.sphx-glr-thumbcontainer img {
2936
width: 250px !important;
30-
display: none;
3137
}
3238
.sphx-glr-thumbcontainer a.internal {
3339
padding: 20px !important;

docs/conf.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
import sphinx_rtd_theme
1717
import sphinx_autopackagesummary
1818

19+
from siibra import __version__ as siibra_version
20+
1921
os.environ['SIIBRA_LOG_LEVEL'] = "ERROR"
2022
sys.path.insert(0, os.path.abspath(".."))
2123
print("Path:", sys.path)
@@ -26,7 +28,8 @@
2628
project = "siibra-python"
2729
copyright = "2020-2023, Forschungszentrum Juelich GmbH"
2830
author = "Big Data Analytics Group, Institute of Neuroscience and Medicine, Forschungszentrum Juelich GmbH"
29-
31+
language = 'en'
32+
version = siibra_version
3033

3134
# -- General configuration ---------------------------------------------------
3235

@@ -87,6 +90,8 @@
8790
"filename_pattern": r"^.*.py", # which files to execute and include their outputs
8891
"capture_repr": ("_repr_html_", "__repr__"),
8992
"within_subsection_order": FileNameSortKey,
93+
"remove_config_comments": True,
94+
"show_signature": False,
9095
}
9196

9297
# List of patterns, relative to source directory, that match files and
@@ -120,21 +125,16 @@
120125

121126
# overriding some styles in a custom CSS
122127
html_css_files = ["siibra.css"]
128+
# other html details
123129
html_show_sourcelink = False
124-
html_logo = "../images/siibra-python.jpeg"
130+
html_logo = "_static/siibra-python.jpeg"
125131
html_permalinks = False
126132

127133
source_suffix = [".rst"]
128134

129135
autoclass_content = 'both'
130136

131-
# -- Sphinxext configuration --------------------------------------------------
132-
133-
# Set attributes for layout of inheritance diagrams
134-
inheritance_graph_attrs = dict(rankdir='LR', size='"6.0, 8.0"', fontsize=14, ratio='compress')
135-
inheritance_node_attrs = dict(
136-
shape='ellipse', fontsize=14, height=0.75, color='dodgerblue1', style='filled'
137-
)
138-
139137
# Example configuration for intersphinx: refer to the Python standard library.
140-
#intersphinx_mapping = {'https://docs.python.org/3/': None}
138+
#intersphinx_mapping = {'https://docs.python.org/3/': None}
139+
140+
# -- Sphinxext configuration --------------------------------------------------

images/siibra-python.jpeg

-50.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)