diff --git a/doc/source/conf.py b/doc/source/conf.py index 446b5ac4..9aaeda83 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,7 +1,8 @@ -from sphinx_gallery.sorting import FileNameSortKey -import warnings +from datetime import datetime import os +import warnings +from sphinx_gallery.sorting import FileNameSortKey import pyvista import numpy as np @@ -66,8 +67,8 @@ # General information about the project. project = u'PyMAPDL Legacy Reader' -copyright = '(c) 2021 ANSYS, Inc. All rights reserved' -author = 'ANSYS Inc.' +copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved" +author = "ANSYS Inc." # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -136,12 +137,16 @@ # -- 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_options = { "github_url": "https://github.com/pyansys/pymapdl-reader", "show_prev_next": False, - "logo_link": "https://readerdocs.pyansys.com/" # navigate to the main page + "show_breadcrumbs": True, + "additional_breadcrumbs": [ + ("PyAnsys", "https://docs.pyansys.com/"), + ], } # -- Options for HTMLHelp output ------------------------------------------ diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst index c83b410b..64e3038d 100644 --- a/doc/source/getting_started.rst +++ b/doc/source/getting_started.rst @@ -11,5 +11,20 @@ If you have any installation (or other) issues, please open an issue at `pymapdl-reader Issues `_. The ``ansys-mapdl-reader`` supports 64-Bit Windows, Mac OS, and Linux -for Python 3.6 through Pythou 3.8. Support for Python 3.9 is pending -VTK support. +for Python 3.7 through Pythou 3.9. + + +Python 3.10 Extra Instructions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +PyMAPDL-Reader requires the `VTK library `_ which, at the +moment, is not available for Python 3.10 in `their official channel +`_. + +If you wish to install PyMAPDL-Reader in Python 3.10, you can still do it by +using the unofficial VTK wheel from PyVista using ``--find-links``. This tells ``pip`` to look for vtk at `wheels.pyvista.org `_. Use this with:: + + pip install ansys-mapdl-reader --find-links https://wheels.pyvista.org/ + +Please visit `Unofficial VTK Wheels for Python 3.10 +`_ for further details.