Skip to content

Commit b1340b0

Browse files
AlejandroFernandezLucesAlejandroFernandezLuces
committed
fixes
1 parent 288843c commit b1340b0

File tree

8 files changed

+213
-26
lines changed

8 files changed

+213
-26
lines changed

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ celerybeat.pid
131131
.env
132132
.venv
133133
env/
134-
venv/
134+
*venv/
135135
ENV/
136136
env.bak/
137137
venv.bak/

‎doc/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
SPHINXOPTS = -j auto -W --color
66
SPHINXBUILD = sphinx-build
77
APIDIR = api
8-
EXAMPLESDIR = examples
8+
EXAMPLESDIR = examples
99
SOURCEDIR = source
1010
BUILDDIR = _build
1111

‎doc/source/conf.py‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,33 @@
8383
"ansys_sphinx_theme.extension.autoapi",
8484
"sphinx_click", # Required by local-product-launcher
8585
"sphinx_gallery.gen_gallery",
86+
"sphinx_jinja",
8687
]
8788

89+
# sphinx gallery options
90+
sphinx_gallery_conf = {
91+
92+
# path to your examples scripts
93+
"examples_dirs": ["../../examples"],
94+
# path where to save gallery generated examples
95+
"gallery_dirs": ["examples"],
96+
# Pattern to search for example files
97+
"filename_pattern": r"\.py",
98+
# Remove the "Download all examples" button from the top level gallery
99+
"download_all_examples": False,
100+
# Sort gallery example by file name instead of number of lines (default)
101+
"within_subsection_order": "FileNameSortKey",
102+
# directory where function granular galleries are stored
103+
"backreferences_dir": None,
104+
# Modules for which function level galleries are created. In
105+
"doc_module": "ansys-tools-common",
106+
"image_scrapers": ("matplotlib",),
107+
"ignore_pattern": r"__init__\.py",
108+
"thumbnail_size": (350, 350),
109+
"copyfile_regex": r".*\.rst",
110+
}
111+
112+
88113
# numpydoc configuration
89114
numpydoc_show_class_members = False
90115
numpydoc_xref_param_type = True
@@ -125,27 +150,3 @@
125150
# Ignore files
126151
exclude_patterns = ["changelog/*.md"]
127152

128-
# sphinx gallery options
129-
sphinx_gallery_conf = {
130-
# convert rst to md for ipynb
131-
"pypandoc": False,
132-
# path to your examples scripts
133-
"examples_dirs": ["../../examples"],
134-
# path where to save gallery generated examples
135-
"gallery_dirs": ["examples"],
136-
# Pattern to search for example files
137-
"filename_pattern": r"\.py",
138-
# Remove the "Download all examples" button from the top level gallery
139-
"download_all_examples": False,
140-
# Sort gallery example by file name instead of number of lines (default)
141-
"within_subsection_order": "FileNameSortKey",
142-
# directory where function granular galleries are stored
143-
"backreferences_dir": None,
144-
# Modules for which function level galleries are created. In
145-
"doc_module": "ansys-tools-common",
146-
"promote_jupyter_magic": True,
147-
"image_scrapers": ("matplotlib",),
148-
"ignore_pattern": r"__init__\.py",
149-
"thumbnail_size": (350, 350),
150-
"copyfile_regex": r".*\.rst",
151-
}

‎doc/source/examples/index.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
:orphan:
2+
3+
Examples
4+
========
5+
6+
This section shows how to use the local launcher.
7+
8+
9+
.. raw:: html
10+
11+
<div class="sphx-glr-thumbnails">
12+
13+
.. thumbnail-parent-div-open
14+
15+
.. thumbnail-parent-div-close
16+
17+
.. raw:: html
18+
19+
</div>
20+
21+
Examples
22+
========
23+
24+
This section shows how to use the local launcher tool.
25+
26+
27+
.. raw:: html
28+
29+
<div class="sphx-glr-thumbnails">
30+
31+
.. thumbnail-parent-div-open
32+
33+
.. thumbnail-parent-div-close
34+
35+
.. raw:: html
36+
37+
</div>
38+
39+
40+
.. toctree::
41+
:hidden:
42+
:includehidden:
43+
44+
45+
/examples/local_launcher/index.rst
46+
47+
48+
49+
.. only:: html
50+
51+
.. rst-class:: sphx-glr-signature
52+
53+
`Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_

‎doc/source/examples/local_launcher/index.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
3+
.. _sphx_glr_examples_local_launcher:
4+
5+
Examples
6+
========
7+
8+
This section shows how to use the local launcher tool.
9+
10+
11+
.. raw:: html
12+
13+
<div class="sphx-glr-thumbnails">
14+
15+
.. thumbnail-parent-div-open
16+
17+
.. thumbnail-parent-div-close
18+
19+
.. raw:: html
20+
21+
</div>
22+

‎doc/source/examples/local_launcher/sg_execution_times.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
:orphan:
3+
4+
.. _sphx_glr_examples_local_launcher_sg_execution_times:
5+
6+
7+
Computation times
8+
=================
9+
**00:00.000** total execution time for 0 files **from examples\local_launcher**:
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+
* - N/A
36+
- N/A
37+
- N/A

‎doc/source/examples/sg_execution_times.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
:orphan:
3+
4+
.. _sphx_glr_examples_sg_execution_times:
5+
6+
7+
Computation times
8+
=================
9+
**00:00.000** total execution time for 0 files **from examples**:
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+
* - N/A
36+
- N/A
37+
- N/A

‎doc/source/sg_execution_times.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
:orphan:
3+
4+
.. _sphx_glr_sg_execution_times:
5+
6+
7+
Computation times
8+
=================
9+
**00:00.000** total execution time for 0 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+
* - N/A
36+
- N/A
37+
- N/A

0 commit comments

Comments
 (0)