DOCS: Minor changes (#885)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
Co-authored-by: klmcadams <58492561+klmcadams@users.noreply.github.com>

README.rst

@@ -1,5 +1,6 @@
-.. image:: https://raw.githubusercontent.com/ansys/pymechanical/main/doc/source/_static/logo/pymechanical-logo-light.png
+.. image:: https://raw.githubusercontent.com/ansys/pymechanical/main/doc/source/_static/logo/pymechanical-logo.png
    :alt: PyMechanical logo
+   :width: 580px
 
 
 |pyansys| |pypi| |python| |GH-CI| |codecov| |MIT| |black|

doc/changelog.d/885.documentation.md

@@ -0,0 +1 @@
+Minor changes

doc/source/_templates/layout.html

@@ -0,0 +1,15 @@
+{% extends "!layout.html" %}
+
+{% block htmltitle %}
+
+{% if meta is mapping %}
+    {% if 'thispagetitle' in meta %}
+        <title>{{ meta.get("thispagetitle") }}</title>
+    {% else %}
+        {{ super() }}
+    {% endif %}
+{% else %}
+    {{ super() }}
+{% endif %}
+
+{% endblock %}

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

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/"),
     ],

doc/source/contributing.rst

@@ -16,40 +16,49 @@ Clone the repository and install project dependencies
 To clone and install the latest PyMechanical release in development mode, run
 these commands:
 
+Clone the repository and create a virtual environment:
+
 .. code::
 
-    # Clone the repository
-    git clone https://github.com/ansys/pymechanical
-    cd pymechanical
+  # Clone the repository
+  git clone https://github.com/ansys/pymechanical
+  cd pymechanical
+
+  # Create a virtual environment
+  python -m venv .venv
+
+Activate the virtual environment:
+
+.. tab-set::
+
+    .. tab-item:: Windows
 
-    # Create a virtual environment
-    python -m venv .venv
+       .. code::
 
-    # Activate the virtual environment depending on the operating system
-    # Windows
-    .venv\Scripts\activate.bat
+          .venv\Scripts\activate.bat
 
-    # PowerShell
-    .venv\Scripts\Activate.ps1
+    .. tab-item:: PowerShell
 
-    # Linux/UNIX
-    source .venv/bin/activate
+       .. code::
 
-    # Install build system tools
-    python -m pip install --upgrade pip tox flit twine
+          .venv\Scripts\Activate.ps1
 
-    # Install the project in editable mode using one of the following commands:
-    # Install the project dependencies only
-    python -m pip install -e .
+    .. tab-item:: Linux/UNIX
+
+       .. code::
+
+          source .venv/bin/activate
+
+Install tools and dependencies:
+
+.. code::
 
-    # Install the project and test dependencies
-    python -m pip install -e .[tests]
+  # Install build system tools
+  python -m pip install --upgrade pip tox flit twine
 
-    # Install the project and documentation dependencies
-    python -m pip install -e .[doc]
+  # Install the project, documentation, and test dependencies in editable mode
+  python -m pip install -e .[doc,tests]
 
-    # Install the project, test, and documentation dependencies
-    python -m pip install -e .[tests,doc]
 
 Test PyMechanical
 -----------------
@@ -212,8 +221,11 @@ Use the `PyMechanical Issues <https://github.com/ansys/pymechanical/issues>`_
 page to submit questions, report bugs, and request new features. When possible,
 use these templates:
 
-* `Bug report <https://github.com/ansys/pymechanical/issues/new?assignees=&labels=bug&projects=&template=bug.yml&title=Bug+located+in+...>`_
-* `Feature request <https://github.com/ansys/pymechanical/issues/new?assignees=&labels=enhancement&projects=&template=feature.yml&title=Add+...>`_
+* `File a bug report <https://github.com/ansys/pymechanical/issues/new?assignees=&labels=bug&projects=&template=bug.yml&title=Bug+located+in+...>`_
+* `File a documentation issue <https://github.com/ansys/pymechanical/issues/new?assignees=&labels=documentation&projects=&template=documentation.yml&title=Modify+...>`_
+* `Request a feature <https://github.com/ansys/pymechanical/issues/new?assignees=&labels=enhancement&projects=&template=feature.yml&title=Add+...>`_
+* `Add an example <https://github.com/ansys/pymechanical/issues/new?assignees=&labels=example&projects=&template=examples.yml&title=Example+proposal%3A+...>`_
+* `Post all other issues <https://github.com/ansys/pymechanical/issues/new>`_
 
 If your issue does not fit into one of these template categories, create your own issue.
 

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
+   wsl
+   ../architecture

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

doc/source/user_guide_embedding/index.rst

@@ -14,6 +14,7 @@ an instance of Mechanical in Python.
    :maxdepth: 1
    :hidden:
 
+   self
    configuration
    globals
    logging

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

doc/source/user_guide_session/index.rst

@@ -14,6 +14,7 @@ to a remote Mechanical session.
    :maxdepth: 1
    :hidden:
 
+   self
    server-launcher
    mechanical
    pool

doc/styles/.gitignore

@@ -1,4 +1,6 @@
 *
-!vocabularies
-!vocabularies/**
+!config
+!config/vocabularies
+!config/vocabularies/ANSYS
+!config/vocabularies/ANSYS/**
 !.gitignore

doc/styles/config/vocabularies/ANSYS/accept.txt

@@ -1,60 +1,61 @@
+ACT
+addin
+Addins
+ans
 ANSYS
 Ansys
 ansys
-automations
+APIs
 Apptainer
+automations
 CentOS
 CentOS7
+cli
+Codecov
+config
+CPUs
+CPython
+discretized
 Docker
 docker
+enum
 ethernet
 ethernet's
+Fowler
 generateHosts
+github
+Globals
+globaly
 hostname
 Hostname
+idempotency
+isort
+linux
+Linux
+Martin
 Mechanical
 mechanical
+middleware
+multiphysics
+mutexes
+namespaces
 OptiSLang
+pessimizations
 PyAnsys
 pyansys
 PyMechanical
 Pythonically
 Python.NET
 pythonnet
+Remoting
+REST
+RPCs
+spaceclaim
+stdout
+thispagetitle
 venv
+VPN
 Windows
 windows
 WSL
 wsl
-stdout
-CPython
-namespaces
-Globals
-linux
-Linux
-APIs
-multiphysics
-discretized
-CPUs
-enum
-config
-pessimizations
-mutexes
-addin
-Addins
-isort
-Codecov
-idempotency
-Martin
-Fowler
-RPCs
-Remoting
-middleware
-REST
-cli
-VPN
-ACT
-globaly
-ans
-spaceclaim
-github