Skip to content

Commit b479106

Browse files
committed
Update Sphinx
1 parent 8e5ece9 commit b479106

8 files changed

Lines changed: 358 additions & 73 deletions

File tree

.github/workflows/ci.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,7 @@ jobs:
120120
python-version: ${{ matrix.python-version }}
121121
- name: test
122122
run: |
123-
poetry run sphinx-build docs/source build/documentation/ -W -b html
124-
poetry run sphinx-build docs/source build/documentation/ -W -b doctest
123+
poetry run sphinx-build docs/source build/documentation/ -W -vvv -b doctest
125124
126125
unit-test:
127126
name: "🧪 Run Unit Tests"
@@ -157,7 +156,7 @@ jobs:
157156
python-version: "3.13"
158157
- name: build docs
159158
run: |
160-
poetry run sphinx-build docs/source build/documentation/ -W -b html
159+
poetry run sphinx-build docs/source build/documentation/ -W -vvv -b html
161160
- name: Store docs
162161
uses: actions/upload-artifact@v5
163162
with:

.tool-versions

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
poetry 2.2.1
2-
python 3.12.10
2+
python 3.14.0

Makefile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ check: check-format lint typecheck audit
3939

4040
.PHONY: doctest
4141
doctest: ## Run doctests
42-
poetry run sphinx-build docs/source build/documentation/ -W -b html
4342
poetry run sphinx-build docs/source build/documentation/ -W -b doctest
4443

4544
.PHONY: unit-test
@@ -61,7 +60,7 @@ check-wheel: wheel
6160

6261
.PHONY: docs
6362
docs: ## Build documentation
64-
poetry run sphinx-build docs/source build/documentation/ -W -b html
63+
poetry run sphinx-build docs/source build/documentation/ -W -vvv -b html
6564

6665
.PHONY: build
6766
build: ## Build all distributables

docs/source/api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Mesh2VecBase
88
:toctree: generated/
99
:template: class.rst
1010

11-
mesh2vec.mesh2vec_base.Mesh2VecBase
11+
mesh2vec_base.Mesh2VecBase
1212

1313
Mesh2VecCae
1414
~~~~~~~~~~~~~~~~
@@ -17,5 +17,5 @@ Mesh2VecCae
1717
:toctree: generated/
1818
:template: class.rst
1919

20-
mesh2vec.mesh2vec_cae.Mesh2VecCae
20+
mesh2vec_cae.Mesh2VecCae
2121

docs/source/conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
project = "Mesh2vec"
1010
copyright = "2023, Renumics GmbH"
1111
author = "Renumics GmbH"
12-
from sphinx_gallery.sorting import FileNameSortKey
1312

1413

1514
# -- General configuration ---------------------------------------------------
@@ -40,7 +39,7 @@
4039
"gallery_dirs": [
4140
"generated_examples",
4241
], # path to where to save gallery generated output
43-
"within_subsection_order": FileNameSortKey,
42+
"within_subsection_order": "FileNameSortKey",
4443
"filename_pattern": "/",
4544
# directory where function/class granular galleries are stored
4645
"backreferences_dir": "generated_backreferences",
@@ -57,7 +56,7 @@
5756
html_static_path = ["_static"]
5857

5958
html_theme = "sphinx_rtd_theme"
60-
html_theme_options = {"logo_only": True, "display_version": False}
59+
html_theme_options = {"logo_only": True}
6160
html_css_files = ["custom.css"]
6261

6362
import plotly.io as pio

docs/source/sg_execution_times.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
2+
:orphan:
3+
4+
.. _sphx_glr_sg_execution_times:
5+
6+
7+
Computation times
8+
=================
9+
**00:00.000** total execution time for 5 files **from all galleries**:
10+
11+
.. container::
12+
13+
.. raw:: html
14+
15+
<style scoped>
16+
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
17+
<link href="https://cdn.datatables.net/1.13.6/css/dataTables.bootstrap5.min.css" rel="stylesheet" />
18+
</style>
19+
<script src="https://code.jquery.com/jquery-3.7.0.js"></script>
20+
<script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script>
21+
<script src="https://cdn.datatables.net/1.13.6/js/dataTables.bootstrap5.min.js"></script>
22+
<script type="text/javascript" class="init">
23+
$(document).ready( function () {
24+
$('table.sg-datatable').DataTable({order: [[1, 'desc']]});
25+
} );
26+
</script>
27+
28+
.. list-table::
29+
:header-rows: 1
30+
:class: table table-striped sg-datatable
31+
32+
* - Example
33+
- Time
34+
- Mem (MB)
35+
* - :ref:`sphx_glr_generated_examples_aggregate_categorical.py` (``../examples/aggregate_categorical.py``)
36+
- 00:00.000
37+
- 0.0
38+
* - :ref:`sphx_glr_generated_examples_aggregate_warpage.py` (``../examples/aggregate_warpage.py``)
39+
- 00:00.000
40+
- 0.0
41+
* - :ref:`sphx_glr_generated_examples_plot_neighbor_distances.py` (``../examples/plot_neighbor_distances.py``)
42+
- 00:00.000
43+
- 0.0
44+
* - :ref:`sphx_glr_generated_examples_plot_stress.py` (``../examples/plot_stress.py``)
45+
- 00:00.000
46+
- 0.0
47+
* - :ref:`sphx_glr_generated_examples_quickstart.py` (``../examples/quickstart.py``)
48+
- 00:00.000
49+
- 0.0

0 commit comments

Comments
 (0)