Skip to content
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

add breadcrumbs #118

Merged
merged 1 commit into from
Feb 24, 2022
Merged

add breadcrumbs #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 ------------------------------------------
Expand Down
19 changes: 17 additions & 2 deletions doc/source/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,20 @@ If you have any installation (or other) issues, please open an issue
at `pymapdl-reader Issues <https://github.com/pyansys/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 <https://vtk.org/>`_ which, at the
moment, is not available for Python 3.10 in `their official channel
<https://pypi.org/project/vtk/>`_.

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 <https://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
<https://github.com/pyvista/pyvista/discussions/2064>`_ for further details.