Skip to content

Update sphinx theme #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RobPasMue merged 2 commits into from
Jun 17, 2022
Merged

Update sphinx theme #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d43c464
Improving docs theme
RobPasMue Jun 17, 2022
81dff9f
Typos in docstrings
RobPasMue Jun 17, 2022
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
6 changes: 3 additions & 3 deletions ansys/mapdl/reader/rst.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4675,12 +4675,12 @@ def plot_nodal_elastic_strain(
node_components : list, optional
Accepts either a string or a list strings of node
components to plot. For example:
``['MY_COMPONENT', 'MY_OTHER_COMPONENT]``
``['MY_COMPONENT', 'MY_OTHER_COMPONENT']``

element_components : list, optional
Accepts either a string or a list strings of element
components to plot. For example:
``['MY_COMPONENT', 'MY_OTHER_COMPONENT]``
``['MY_COMPONENT', 'MY_OTHER_COMPONENT']``

sel_type_all : bool, optional
If node_components is specified, plots those elements
Expand All @@ -4691,7 +4691,7 @@ def plot_nodal_elastic_strain(
when plotting.

**kwargs : keyword arguments
Optional keyword arguments. See ``help(pyvista.plot)``p
Optional keyword arguments. See ``help(pyvista.plot)``

Examples
--------
Expand Down
7 changes: 4 additions & 3 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import pyvista
from sphinx_gallery.sorting import FileNameSortKey
from ansys_sphinx_theme import pyansys_logo_black

from ansys.mapdl import reader as pymapdl_reader

Expand Down Expand Up @@ -90,7 +91,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -141,8 +142,8 @@

# -- Options for HTML output -------------------------------------------------
html_short_title = html_title = "PyMAPDL - Legacy Reader"
html_theme = "pyansys_sphinx_theme"
html_logo = os.path.join("_static", "pyansys-logo-black-cropped.png")
html_theme = "ansys_sphinx_theme"
html_logo = pyansys_logo_black
html_theme_options = {
"github_url": "https://github.com/pyansys/pymapdl-reader",
"show_prev_next": False,
Expand Down
2 changes: 1 addition & 1 deletion doc/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _contributing:
.. _ref_contributing:

============
Contributing
Expand Down
3 changes: 1 addition & 2 deletions requirements_docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,5 @@ pytest-sphinx
sphinx-notfound-page>=0.3.0
sphinx-copybutton
sphinx-gallery>=0.8.1
pyansys_sphinx_theme
pypandoc
ansys_sphinx_theme
vtk<9.1.0