Building an example#
To run the documentation, you need to have the correct versions of each tool. To do so, execute the following instruction.
pip install -r requirements/requirements_docs.txt
The Sphinx configuration is in the file
conf.py in doc/source.
To run the sphinx tool:
doc\make.bat html
There are three types of examples: dynamic, static, and semi-static.
Dynamic examples#
The dynamic examples are based on Python files and must be able to run in under three minutes.
They are in the examples directory in this repository.
Example: 2d_plate_with_a_hole.py .. vale on
Here is a link to this dynamic example: MAPDL 2D Plane Stress Concentration Analysis
When an example is executed, Total running time of the script appears at the end of the document.
Static examples#
Static examples are based on RST files and are not executed.
They are in the docsource directory. .. vale off
Example: krylov_example.rst .. vale on
Here is a link to this static example: Harmonic analysis using the frequency-sweep Krylov method
Semi-dynamic examples#
Semi-dynamic examples are RST files that execute Python code using this RST directive:
.. jupyter-execute::
:hide-code:
Example: tecfricstir.rst .. vale on
Here is a link to this semi-dynamic example: Friction Stir Welding (FSW) Simulation
Recommendations#
As dynamic examples must run each time documentation is built, make sure that they are very short. To get around the problem of execution time, feel free to use static or semi-static examples.