Skip to content

Small documentation fixes #2062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 30, 2023
Merged

Small documentation fixes #2062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6478945
fixing cartpole link
germa89 May 19, 2023
606244d
changing krylov file links
germa89 May 19, 2023
4249b35
Using reference link
germa89 May 19, 2023
c299984
Atempting to remove subsections on the left bar
germa89 May 19, 2023
83357b4
bold header row
germa89 May 19, 2023
5bfe803
Improving header
germa89 May 19, 2023
1b812f7
DOC: fix the toctree content
Revathyvenugopal162 May 23, 2023
a3d6729
Merge branch 'main' into doc/fix-cartpole-link
Revathyvenugopal162 May 23, 2023
e84f39c
Merge branch 'main' into doc/fix-cartpole-link
germa89 May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...ic_Analysis_using_krylov_pymapdl_15_1.png → ...ended_examples/Krylov/files/file_15_1.png
View file
Open in desktop
File renamed without changes
0 ...ic_Analysis_using_krylov_pymapdl_36_1.png → ...ended_examples/Krylov/files/file_36_1.png
View file
Open in desktop
File renamed without changes
0 ...ic_Analysis_using_krylov_pymapdl_38_0.png → ...ended_examples/Krylov/files/file_38_0.png
View file
Open in desktop
File renamed without changes
6 changes: 3 additions & 3 deletions doc/source/examples/extended_examples/Krylov/krylov_example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ a length element size constraint to the longitudinal lines.
mapdl.eplot()


.. image:: ../../../examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_15_1.png
.. image:: files/file_15_1.png


Define boundary conditions
Expand Down Expand Up @@ -370,7 +370,7 @@ Plot the calculated data.
plt.show()


.. image:: ../../../examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_36_1.png
.. image:: files/file_36_1.png


Plot the frequency response function
Expand Down Expand Up @@ -432,4 +432,4 @@ Plot the frequency response function for the selected node.
plt.show()


.. image:: ../../../examples/extended_examples/Krylov/Harmonic_Analysis_using_krylov_pymapdl_files/Harmonic_Analysis_using_krylov_pymapdl_38_0.png
.. image:: files/file_38_0.png
16 changes: 13 additions & 3 deletions doc/source/examples/extended_examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
Extended examples
=================


These extended examples explain other concepts such as interoperability
with other programs, libraries, and features in development.

+----------------------------+---------------------------------------------------------------------------------------------------------+
| Name | Description |
| **Name** | **Description** |
+----------------------------+---------------------------------------------------------------------------------------------------------+
| `Cart-Pole Simulation`_ | Demonstrates a reinforcement machine learning example using MAPDL through PyMAPDL. |
+----------------------------+---------------------------------------------------------------------------------------------------------+
Expand All @@ -24,4 +23,15 @@ with other programs, libraries, and features in development.
+----------------------------+---------------------------------------------------------------------------------------------------------+


.. _Cart-Pole Simulation: https://pyansys.github.io/ml-rl-cartpole/ml-rl-notebook.html
.. _Cart-Pole Simulation: cartpole_example_notebook_

.. toctree::
:hidden:
:maxdepth: 2

Cart-Pole Simulation <http://cartpole.mapdl.docs.pyansys.com/ml-rl-notebook.html>
ex_01-gmsh_example/ex_01-gmsh_example.rst
Python_UPF/python_upf_examples.rst
Krylov/krylov_example.rst
dash/dash_example.rst
executable/executable.rst
12 changes: 2 additions & 10 deletions doc/source/examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,18 @@ Here are a series of examples using MAPDL with the ``ansys-mapdl-core`` library.

Verification Manual <https://examples.mapdl.docs.pyansys.com/verif-manual/index.html>
Technology Showcases <https://examples.mapdl.docs.pyansys.com/technology_showcase_examples/index.html>
extended_examples/index.rst


.. include:: pymapdl_examples_repo/index.rst
:start-line: 2

.. === EXTENDED EXAMPLES ===

.. toctree::
:hidden:
:maxdepth: 3

Cart-Pole Simulation <https://pyansys.github.io/ml-rl-cartpole/ml-rl-notebook.html>
extended_examples/ex_01-gmsh_example/ex_01-gmsh_example
extended_examples/Python_UPF/python_upf_examples
extended_examples/Krylov/krylov_example
extended_examples/dash/dash_example
extended_examples/executable/executable

.. include:: extended_examples/index.rst
:start-line: 2
:end-line: 27


.. === DOWNLOAD EXAMPLES ===
Expand Down
1 change: 1 addition & 0 deletions doc/source/links.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@
.. _pymapdl_docker_compose_local: https://github.com/pyansys/pymapdl/blob/main/docker/docker-compose.local.yml
.. _pymapdl_docker_compose_license_server: https://github.com/pyansys/pymapdl/blob/main/docker/docker-compose.license_server.yml
.. _pymapdl_discussion_differences_mapdl_pymapdl: https://github.com/pyansys/pymapdl-reader/issues/185
.. _cartpole_example_notebook: https://cartpole.mapdl.docs.pyansys.com/ml-rl-notebook.html

.. #Python
.. _using_venv: https://docs.python.org/3/library/venv.html
Expand Down
4 changes: 2 additions & 2 deletions examples/04-general-fea/00-how_finite_element_works.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
"""
.. _build_element_example:

Build a Finite Element
----------------------
Build a Finite Element Model
----------------------------

A finite element machinery built for a quadrilateral element using an
isoparametric formulation and validated with PyMAPDL.
Expand Down