ansys / pymapdl

Pythonic interface to MAPDL
https://mapdl.docs.pyansys.com
MIT License
428 stars 120 forks source link

Section about example building for doc in contribution #1585

Closed germa89 closed 1 year ago

germa89 commented 2 years 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:

Notes

There are three types of examples:

.. 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.

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

germa89 commented 2 years ago

Add also piracy policy somewhere.

germa89 commented 2 years ago

Updating issue text