Skip to content

Commit dadd0db

Browse files
committed
feat: add full-width CSS and examples documentation
1 parent 2c6080d commit dadd0db

File tree

4 files changed

+43
-11
lines changed

4 files changed

+43
-11
lines changed

docs/_static/fullwidth.css

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/* PyData Sphinx Theme Full Width CSS - Simplest Approach */
2+
/* Apply full-width to all main containers */
3+
4+
.bd-container,
5+
.bd-container__inner {
6+
max-width: 100% !important;
7+
}
8+
9+
.bd-main,
10+
.bd-content {
11+
max-width: 100% !important;
12+
}
13+
14+
.bd-article-container,
15+
.bd-article {
16+
max-width: 100em !important;
17+
}
18+
19+
/* Ensure notebook cells use full width */
20+
.cell,
21+
.cell_input,
22+
.cell_output {
23+
max-width: 100% !important;
24+
}

docs/conf.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@
3333
html_theme_options: dict[str, Any] = {
3434
# "announcement": announcement,
3535
"logo": {
36-
"text": "Magpylib",
37-
"image_dark": "./_static/images/magpylib_logo.png",
36+
"text": "Magpylib-Material-Response",
37+
"image_light": "_static/images/magpylib_logo.png",
38+
"image_dark": "_static/images/magpylib_logo.png",
3839
},
3940
"header_links_before_dropdown": 4,
4041
"show_version_warning_banner": True,
@@ -94,5 +95,8 @@
9495

9596
html_js_files = [
9697
"https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js",
97-
# "https://unpkg.com/thebe@latest/lib/index.js",
9898
]
99+
100+
# Static files (CSS/JS)
101+
html_static_path = ["_static"]
102+
html_css_files = ["fullwidth.css"]

docs/examples/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Examples
2+
3+
This section contains examples demonstrating the use of Magpylib-Material-Response.
4+
5+
```{toctree}
6+
:maxdepth: 1
7+
:glob:
8+
9+
*
10+
```

docs/index.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# magpylib-material-response
1+
# Documentation
22

33
```{include} ../README.md
44
:start-after: <!-- SPHINX-START -->
@@ -8,14 +8,8 @@
88
:caption: CONTENT
99
:glob: true
1010
:maxdepth: 2
11-
```
12-
13-
```{toctree}
14-
:caption: EXAMPLES
15-
:glob: true
16-
:maxdepth: 2
1711
18-
examples/*
12+
examples/index
1913
```
2014

2115
## Indices and tables

0 commit comments

Comments
 (0)