Skip to content

Commit

Permalink
add title
Browse files Browse the repository at this point in the history
  • Loading branch information
dipinknair committed Aug 27, 2024
1 parent 3fcb4fb commit 4eff2eb
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 16 deletions.
2 changes: 1 addition & 1 deletion doc/source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ protocol.

Applications that conform to REST are said to provide RESTful APIs. For a more
detailed description, see `What is a REST API
<https://www.redhat.com/en/topics/api/what-is-a-rest-api>` on the *Red Hat
<https://www.redhat.com/en/topics/api/what-is-a-rest-api>`_ on the *Red Hat
Technology Topics* page.

Remote method invocation
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@
"show_breadcrumbs": True,
"collapse_navigation": True,
"use_edit_page_button": True,
"header_links_before_dropdown": 5, # number of links before the dropdown menu
"header_links_before_dropdown": 7, # number of links before the dropdown menu
"additional_breadcrumbs": [
("PyAnsys", "https://docs.pyansys.com/"),
],
Expand Down
3 changes: 3 additions & 0 deletions doc/source/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ an embedded instance or remote session.

.. grid-item-card:: Embedding Examples
:padding: 2 2 2 2
:text-align: center
:link: https://embedding.examples.mechanical.docs.pyansys.com/examples/index.html

Uses PyMechanical to embed an instance of Mechanical directly within Python as a Python object.

.. grid-item-card:: Remote Session Examples
:padding: 2 2 2 2
:text-align: center
:link: https://examples.mechanical.docs.pyansys.com/examples/index.html

Uses PyMechanical as a client to a remote Mechanical instance.
Expand All @@ -24,6 +26,7 @@ an embedded instance or remote session.

.. grid-item-card:: Embedding Instance & Remote Session Example
:padding: 2 2 2 2
:text-align: center
:link: gallery_examples/embedding_n_remote/embedding_remote.html

Demonstrates the same model setup in both an embedded instance and remote session,
Expand Down
20 changes: 9 additions & 11 deletions doc/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,6 @@ interface to drive the software that facilitates the use of

.. grid:: 1 2 2 2

.. grid-item-card:: Background
:padding: 2 2 2 2
:link: ../architecture
:link-type: doc
:text-align: left

Information on the application architecture of Mechanical and why there are two Python interfaces.

.. grid-item-card:: Installation guide
:padding: 2 2 2 2
:link: installation
Expand Down Expand Up @@ -51,16 +43,22 @@ interface to drive the software that facilitates the use of
:link-type: doc
:text-align: left

Using PyMechanical with Windows Subsystem for Linux.
Installing PyMechanical on Linux via WSL.


Background
----------

PyMechanical contains two interfaces: a remote session and an embedded instance.
For information on the application architecture of Mechanical and why there are
two Python interfaces, see :ref:`ref_architecture`.

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

../architecture
installation
running_mechanical
docker
wsl
wsl
../architecture
10 changes: 7 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@

:thispagetitle: PyMechanical

Check failure on line 2 in doc/source/index.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/index.rst#L2

[Vale.Spelling] Did you really mean 'thispagetitle'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'thispagetitle'?", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 2, "column": 2}}}, "severity": "ERROR"}


.. image:: /_static/logo/pymechanical-logo-light.png
:class: only-light
:alt: PyMechanical Logo
:alt: PyMechanical Logo Light
:width: 580px
:align: center

.. image:: /_static/logo/pymechanical-logo-dark.png
:class: only-dark
:alt: PyMechanical
:alt: PyMechanical Logo Dark
:width: 580px
:align: center

Expand Down Expand Up @@ -101,6 +104,7 @@ Python API to interact with `Ansys Mechanical`_ (FEA software for structural eng

:bdg-primary-line:`Test` :bdg-primary-line:`Documentation` :bdg-primary-line:`Issues`


.. toctree::
:hidden:
:maxdepth: 3
Expand All @@ -111,7 +115,7 @@ Python API to interact with `Ansys Mechanical`_ (FEA software for structural eng
user_guide_embedding/index
user_guide_scripting/index
api/index
contributing
kil/index
faq
contributing
changelog
1 change: 1 addition & 0 deletions doc/source/user_guide_embedding/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ an instance of Mechanical in Python.
:maxdepth: 1
:hidden:

self
configuration
globals
logging
Expand Down
1 change: 1 addition & 0 deletions doc/source/user_guide_scripting/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This section provides an overview of Mechanical scripting.
:maxdepth: 1
:hidden:

self
threading

Overview
Expand Down
1 change: 1 addition & 0 deletions doc/source/user_guide_session/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ to a remote Mechanical session.
:maxdepth: 1
:hidden:

self
server-launcher
mechanical
pool
Expand Down

0 comments on commit 4eff2eb

Please sign in to comment.