Skip to content

Commit

Permalink
modernize docbuild (#760)
Browse files Browse the repository at this point in the history
* inprogress

* remove templates in favor of main theme
  • Loading branch information
akaszynski authored Dec 4, 2021
1 parent 0c46e1d commit 58939c5
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 171 deletions.
Binary file removed doc/source/_static/pyansys-logo-black-cropped.png
Binary file not shown.
5 changes: 0 additions & 5 deletions doc/source/_templates/autosummary/base.rst

This file was deleted.

34 changes: 0 additions & 34 deletions doc/source/_templates/autosummary/class.rst

This file was deleted.

34 changes: 0 additions & 34 deletions doc/source/_templates/custom-class-template.rst

This file was deleted.

66 changes: 0 additions & 66 deletions doc/source/_templates/custom-module-template.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/source/api/geometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ Geometry

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

mapdl_geometry.Geometry
1 change: 0 additions & 1 deletion doc/source/api/math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ These classes are specific to the ``MapdlMath`` module:

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

math.MapdlMath
math.ApdlMathObj
Expand Down
1 change: 0 additions & 1 deletion doc/source/api/mesh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ Mesh

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

mesh_grpc.MeshGrpc
1 change: 0 additions & 1 deletion doc/source/api/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ Parameters

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

parameters.Parameters
1 change: 0 additions & 1 deletion doc/source/api/pool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ Local MAPDL Pool

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

pool.LocalMapdlPool
1 change: 0 additions & 1 deletion doc/source/api/post.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,5 @@ you can use one of the following packages:

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

post.PostProcessing
1 change: 0 additions & 1 deletion doc/source/api/solution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Solution

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

solution.Solution

1 change: 0 additions & 1 deletion doc/source/api/xpl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@ Database Explorer

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst

xpl.ansXpl
8 changes: 2 additions & 6 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@
import pyvista
import numpy as np
from sphinx_gallery.sorting import FileNameSortKey
from pyansys_sphinx_theme import pyansys_logo_black

import sys

sys.path.append("../..")
from ansys.mapdl.core import __version__


# Manage errors
pyvista.set_error_output_file("errors.txt")

Expand Down Expand Up @@ -159,11 +156,10 @@

# -- Options for HTML output -------------------------------------------------
html_theme = "pyansys_sphinx_theme"
html_logo = os.path.join("_static", "pyansys-logo-black-cropped.png")
html_logo = pyansys_logo_black
html_theme_options = {
"github_url": "https://github.com/pyansys/pymapdl",
"show_prev_next": False,
"logo_link": "https://docs.pyansys.com/", # navigate to the main page
}

# -- Options for HTMLHelp output ---------------------------------------------
Expand Down
38 changes: 20 additions & 18 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,17 @@ PyMAPDL Documentation

Introduction and Purpose
------------------------
PyMAPDL is part of the larger PyAnsys effort to facilitate the use
of Ansys technologies directly from Python. Its primary package,
``ansys-mapdl-core``, provides:

- scripting of MAPDL through both Python and Ansys Parametric Design
Language (APDL) syntax
- plotting of MAPDL geometry and meshes using VTK from within a Python
script or an interactive Jupyter notebook
- access to MAPDL arrays as Python objects (e.g. nodes, elements,
solution matrices, and results)
PyMAPDL is part of the larger `PyAnsys <https://docs.pyansys.com>`_
effort to facilitate the use of Ansys technologies directly from
Python. Its primary package, ``ansys-mapdl-core``, provides:

- Scripting of MAPDL through both Python and Ansys Parametric Design
Language (APDL) syntax.
- Plotting of MAPDL geometry and meshes using `PyVista
<https://docs.pyvista.org>`_ from within a Python script or an
interactive `Jupyter notebook <https://jupyter.org/>`_.
- Access to MAPDL arrays as Python objects (e.g. nodes, elements,
solution matrices, and results).

With PyMAPDL it is easier than ever to integrate the simulation capabilities
of the Ansys MAPDL multi-physics solver directly into novel applications
Expand All @@ -44,9 +45,10 @@ application. It is now open source: Enjoy it! Contributions are welcome.

Background
----------
PyMAPDL, based on gRPC, represents an improvement over its predecessor based
on CORBA. These technologies allow the MAPDL solver to function as a server,
ready to respond to connecting clients.
PyMAPDL, based on `gRPC <https://grpc.io/>`_, represents an
improvement over its predecessor based on CORBA. These technologies
allow the MAPDL solver to function as a server, ready to respond to
connecting clients.

Google remote procedure calls, or gRPC, are used to establish secure
connections so that a client application can directly call methods on
Expand Down Expand Up @@ -95,10 +97,10 @@ stored to the logging module or can be immediately printed out with

Calling MAPDL Pythonically
~~~~~~~~~~~~~~~~~~~~~~~~~~
MAPDL functions can be called directly from an ``Mapdl`` instance in a
pythonic manner. This is to simplify calling MAPDL, especially when
inputs are variables within Python. For example, the following two
commands are equivalent:
MAPDL functions can be called directly from an :class:`Mapdl
<ansys.mapdl.core.mapdl._MapdlCore>` instance in a pythonic manner. This is to
simplify calling MAPDL, especially when inputs are variables within
Python. For example, the following two commands are equivalent:

.. code:: python
Expand All @@ -110,7 +112,7 @@ example, inputting points from a numpy array:

.. code:: python
# make 10 random keypoints in ANSYS
# make 10 random keypoints in MAPDL
points = np.random.random((10, 3))
for i, (x, y, z) in enumerate(points):
mapdl.k(i + 1, x, y, z)
Expand Down

0 comments on commit 58939c5

Please sign in to comment.