From 4eff2eb74a007c82123f5bafacbc42198f87e458 Mon Sep 17 00:00:00 2001 From: dkunhamb Date: Tue, 27 Aug 2024 13:22:43 -0500 Subject: [PATCH] add title --- doc/source/architecture.rst | 2 +- doc/source/conf.py | 2 +- doc/source/examples/index.rst | 3 +++ doc/source/getting_started/index.rst | 20 +++++++++----------- doc/source/index.rst | 10 +++++++--- doc/source/user_guide_embedding/index.rst | 1 + doc/source/user_guide_scripting/index.rst | 1 + doc/source/user_guide_session/index.rst | 1 + 8 files changed, 24 insertions(+), 16 deletions(-) diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index 199d7901c..e6fd29491 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -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 -` on the *Red Hat +`_ on the *Red Hat Technology Topics* page. Remote method invocation diff --git a/doc/source/conf.py b/doc/source/conf.py index 9a0c6450d..ef7c0796a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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/"), ], diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst index 73527814a..d1af0b40f 100644 --- a/doc/source/examples/index.rst +++ b/doc/source/examples/index.rst @@ -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. @@ -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, diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index bfffdad12..99d9af205 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -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 @@ -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 \ No newline at end of file + wsl + ../architecture \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index e529f4fd8..8ad8ac448 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,13 +1,16 @@ +:thispagetitle: PyMechanical + + .. 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 @@ -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 @@ -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 \ No newline at end of file diff --git a/doc/source/user_guide_embedding/index.rst b/doc/source/user_guide_embedding/index.rst index c0aa4870c..31e57079a 100644 --- a/doc/source/user_guide_embedding/index.rst +++ b/doc/source/user_guide_embedding/index.rst @@ -14,6 +14,7 @@ an instance of Mechanical in Python. :maxdepth: 1 :hidden: + self configuration globals logging diff --git a/doc/source/user_guide_scripting/index.rst b/doc/source/user_guide_scripting/index.rst index 49edf2d3f..2280a98e7 100644 --- a/doc/source/user_guide_scripting/index.rst +++ b/doc/source/user_guide_scripting/index.rst @@ -13,6 +13,7 @@ This section provides an overview of Mechanical scripting. :maxdepth: 1 :hidden: + self threading Overview diff --git a/doc/source/user_guide_session/index.rst b/doc/source/user_guide_session/index.rst index 7ce5e6fe4..febd8c63d 100644 --- a/doc/source/user_guide_session/index.rst +++ b/doc/source/user_guide_session/index.rst @@ -14,6 +14,7 @@ to a remote Mechanical session. :maxdepth: 1 :hidden: + self server-launcher mechanical pool