Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Sphinx documentation configuration file for the pyansys developer's guide."""
"""Sphinx documentation configuration file for the PyAnsys developer's guide."""

from datetime import datetime
import os
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -338,18 +338,18 @@ For installation and search information, see `Downloads <Notepadpp_downloads_>`_
Notepad\+\+ is also handy if you want to open one file in it to visually compare it to
another file that you have open in Visual Studio Code.

Install Sphinx and the Ansys Sphinx theme
Install Sphinx and the Ansys Sphinx Theme
-----------------------------------------
`Sphinx <Sphinx_>`_, which uses reStructuredText as its default plaintext markup language, is
a tool for generating documentation. While designed primarily for generating documentation
for Python projects, it can be used for generating documentation for other programming languages
and projects.

The `Ansys Sphinx theme <Ansys_Sphinx_theme_repo_>`_ is an Ansys-branded extension of the popular
`PyData Sphinx theme <PyData_Sphinx_theme_>`_. It is used along with Sphinx to assemble PyAnsys
The `Ansys Sphinx Theme <Ansys_Sphinx_theme_repo_>`_ is an Ansys-branded extension of the popular
`PyData Sphinx Theme <PyData_Sphinx_theme_>`_. It is used along with Sphinx to assemble PyAnsys
documentation from a project's RST files and the docstrings in its PY files.

Install both Sphinx and the Ansys Sphinx theme so that you can build PyAnsys documentation
Install both Sphinx and the Ansys Sphinx Theme so that you can build PyAnsys documentation
locally:

#. If the Ansys Python Manager and **Administrator** window are not still
Expand All @@ -371,8 +371,15 @@ locally:

The window displays installation information. The Sphinx ``conf.py`` file
in the ``doc`` directory of a PyAnsys repository is already configured to use
this theme.
the Ansys Sphinx Theme.

Your development environment is now set up. If you are new to contributing to
PyAnsys documentation, see :ref:`essentials_writers`. For lists of resources related
to contributing to PyAnsys documentation, see :ref:`resources_writers`.

.. note::
You can customize the Ansys Sphinx Theme by making changes to the
``html_theme_options`` dictionary in the Sphinx configuration (``conf.py``)
file in the ``doc`` directory. For additional information, see
`HTML theme options <https://sphinxdocs.ansys.com/version/stable/user_guide/options.html>`_
in the Ansys Sphinx Theme documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ building of PyAnsys documentation.
QT app for installing Python and managing your Python environment, including creating
virtual environments, launching a command console, installing PyAnsys packages, and
viewing PyAnsys documentation.
- `Ansys Sphinx theme <Ansys_Sphinx_theme_repo_>`_: Provides an Ansys-branded extension
of the popular `PyData Sphinx theme <PyData_Sphinx_theme_>`_ that is used to generate
- `Ansys Sphinx Theme <Ansys_Sphinx_theme_repo_>`_: Provides an Ansys-branded extension
of the popular `PyData Sphinx Theme <PyData_Sphinx_theme_>`_ that is used to generate
PyAnsys documentation.
- `Ansys templates <Ansys_templates_>`_: Provides templates for creating PyAnsys projects
that are compliant with PyAnsys guidelines.
Expand Down
1 change: 1 addition & 0 deletions doc/source/content-writing/content-how-tos/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ can post questions, share ideas, and get community feedback on the
edit-on-GitHub
view-revision-history
add-sphinx-extensions
show_cheat_sheet_thumbnail
create-issues-discussions
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _show_cheat_sheet_thumbnail:

Show cheat sheet thumbnail
==========================

If a cheat sheet exists for a PyAnsys library, you can show a thumbnail of it in the
left navigation pane of one or more documentation pages. For example, this image
shows a cheat sheet thumbnail on the landing page of the PyMechanical documentation:

.. image:: ../_static/cheat-sheet-nav-pane.png
:alt: Cheat sheet thumbnail in PyMechanical documentation

To show a thumbnail, you add a child ``cheatsheet`` dictionary to the Sphinx
configuration (``conf.py``) file in the ``doc`` directory as described in
`Cheat Sheets <https://sphinxdocs.ansys.com/version/stable/user_guide/options.html#cheat-sheets>`_
in the Ansys Sphinx Theme documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ page in the *Goggle developer documentation style guide*.

Roles insert semantic markup in your source files for cross-references to named
targets of the type indicated by the role. Because the CSS for the
`Ansys Sphinx theme <Ansys_Sphinx_theme_repo_>`_ assigns the same semantic markup to
`Ansys Sphinx Theme <Ansys_Sphinx_theme_repo_>`_ assigns the same semantic markup to
the ``file`` role as it does to a filename surrounded in double backticks, it
does not matter which markup you use.

Expand Down
1 change: 1 addition & 0 deletions doc/styles/config/vocabularies/ANSYS/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ sublist
substring
superset
tensorflow
Theme
TXT
turbomachinery
UDFs
Expand Down