Skip to content

Commit 5a92a48

Browse files
authored
Update build_doc.bat due to the move into src/ (#775)
* Update build_doc.bat due to the move into src/ * Fix doc warnings * augment timeout of doc generation * augment timeout of doc generation
1 parent 55a0e9e commit 5a92a48

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

.ci/build_doc.bat

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
set SPHINX_APIDOC_OPTIONS=inherited-members
2-
call sphinx-apidoc -o ../docs/source/api ../ansys ../ansys/dpf/core/log.py ^
3-
../ansys/dpf/core/help.py ../ansys/dpf/core/mapping_types.py ../ansys/dpf/core/ipconfig.py ^
4-
../ansys/dpf/core/field_base.py ../ansys/dpf/core/cache.py ../ansys/dpf/core/misc.py ^
5-
../ansys/dpf/core/check_version.py ../ansys/dpf/core/operators/build.py ../ansys/dpf/core/operators/specification.py ^
6-
../ansys/dpf/core/vtk_helper.py ../ansys/dpf/core/label_space.py ../ansys/dpf/core/examples/python_plugins/* ^
7-
../ansys/dpf/core/examples/examples.py ^
2+
call sphinx-apidoc -o ../docs/source/api ../src/ansys ../src/ansys/dpf/core/log.py ^
3+
../src/ansys/dpf/core/help.py ../src/ansys/dpf/core/mapping_types.py ../src/ansys/dpf/core/ipconfig.py ^
4+
../src/ansys/dpf/core/field_base.py ../src/ansys/dpf/core/cache.py ../src/ansys/dpf/core/misc.py ^
5+
../src/ansys/dpf/core/check_version.py ../src/ansys/dpf/core/operators/build.py ../src/ansys/dpf/core/operators/specification.py ^
6+
../src/ansys/dpf/core/vtk_helper.py ../src/ansys/dpf/core/label_space.py ../src/ansys/dpf/core/examples/python_plugins/* ^
7+
../src/ansys/dpf/core/examples/examples.py ^
88
-f --implicit-namespaces --separate --no-headings
99
pushd .
1010
cd ../docs/

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ jobs:
134134
working-directory: .ci
135135
run: |
136136
build_doc.bat > ..\docs\log.txt && type ..\docs\log.txt 2>&1
137-
timeout-minutes: 20
137+
timeout-minutes: 60
138138

139139
- name: "Check for success"
140140
shell: bash

examples/08-averaging/01-average_across_bodies.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100

101101
###############################################################################
102102
# Workflow for not averaging across bodies
103-
# ---------------------------------
103+
# ----------------------------------------
104104
# Computing Von Mises stresses without averaging across the bodies of the
105105
# model requires the stresses to be extracted separately for each body.
106106
# To do this in DPF, pass a scopings container the stress operator that
@@ -176,7 +176,7 @@ def not_average_across_bodies(analysis):
176176

177177
###############################################################################
178178
# Workflow for averaging across bodies
179-
# -----------------------------------
179+
# ------------------------------------
180180
# The workflow for performing averaging across bodies in DPF is similar to to the
181181
# one shown above, with the extraction of stresses per body. The difference comes
182182
# in the end, where a weighted merge is done between the fields that contain different
@@ -268,7 +268,7 @@ def average_across_bodies(analysis):
268268

269269
###############################################################################
270270
# Dedicated Operator
271-
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
271+
# ~~~~~~~~~~~~~~~~~~
272272
#
273273
# .. note::
274274
# The operator detailed below is available in Ansys 23R2 and later versions.

0 commit comments

Comments
 (0)