Closed germa89 closed 1 year ago
The documentation does not specify how the examples are build (tools, directories, types, etc).
I would like this information to be added to the docs. This documentation should include:
There are three types of examples:
Dynamic (based on a python file). Run under 3 minutes. There are in examples directory in the repo. Example: https://github.com/pyansys/pymapdl/blob/main/examples/00-mapdl-examples/2d_plate_with_a_hole.py
examples
Static (based on RST file) They are in the doc\source directory. Example: https://raw.githubusercontent.com/pyansys/pymapdl/main/doc/source/examples/extended_examples/Krylov/krylov_example.rst
doc\source
Semi-dynamic (an RST file which execute python code). Example: https://raw.githubusercontent.com/pyansys/pymapdl/main/doc/source/examples/technology_showcase_examples/techdemo-28/ex_28-tecfricstir.rst
.. jupyter-execute:: :hide-code: ## figure 28.5 mapdl.allsel("all") mapdl.esel('s', 'mat', '', 2) mapdl.nsle('s')
To install the libraries for running the documentation tools do:
pip install -r requirements/requirements_docs.txt
The Sphinx configuration is in the file conf.py in doc/source.
conf.py
doc/source
To run the sphinx tool:
doc\make.bat html
The new section should be probably around here: https://mapdl.docs.pyansys.com/contribution_and_api/index.html#viewing-pymapdl-documentation
Add also piracy policy somewhere.
Updating issue text
The documentation does not specify how the examples are build (tools, directories, types, etc).
I would like this information to be added to the docs. This documentation should include:
Notes
There are three types of examples:
Dynamic (based on a python file). Run under 3 minutes. There are in
examples
directory in the repo. Example: https://github.com/pyansys/pymapdl/blob/main/examples/00-mapdl-examples/2d_plate_with_a_hole.pyStatic (based on RST file) They are in the
doc\source
directory. Example: https://raw.githubusercontent.com/pyansys/pymapdl/main/doc/source/examples/extended_examples/Krylov/krylov_example.rstSemi-dynamic (an RST file which execute python code). Example: https://raw.githubusercontent.com/pyansys/pymapdl/main/doc/source/examples/technology_showcase_examples/techdemo-28/ex_28-tecfricstir.rst
To install the libraries for running the documentation tools do:
The Sphinx configuration is in the file
conf.py
indoc/source
.To run the sphinx tool:
The new section should be probably around here: https://mapdl.docs.pyansys.com/contribution_and_api/index.html#viewing-pymapdl-documentation