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.

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

Referencing the PDF in the docs #2489

Merged
merged 2 commits into from
Nov 8, 2023
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: 2 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@
rst_epilog += f.read()

rst_epilog = rst_epilog.replace("%%VERSION%%", "v231")
rst_epilog = rst_epilog.replace("%%PYMAPDLVERSION%%", release)


# Read link all substitutions from file
with open("substitutions.rst") as f:
Expand Down
2 changes: 2 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ Documentation and issues
------------------------
Documentation for the latest stable release of PyMAPDL is hosted at `PyMAPDL documentation
<https://mapdl.docs.pyansys.com/version/stable/>`_.
The same documentation is also `available as PDF <pymapdl_latest_pdf_doc_>`_ in the `Assets` section in the
`latest GitHub package release <pymapdl_latest_github_release_>`_.

In the upper right corner of the documentation's title bar, there is an option for switching from
viewing the documentation for the latest stable release to viewing the documentation for the
Expand Down
3 changes: 3 additions & 0 deletions doc/source/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@
.. _pymapdl_discussion_differences_mapdl_pymapdl: https://github.com/ansys/pymapdl-reader/issues/185
.. _cartpole_example_notebook: https://cartpole.mapdl.docs.pyansys.com/ml-rl-notebook.html
.. _wsl_launching_mapdl: https://github.com/ansys/pymapdl/issues/2315
.. _pymapdl_latest_github_release: https://github.com/ansys/pymapdl/releases/latest
.. _pymapdl_latest_pdf_doc: https://github.com/ansys/pymapdl/releases/download/v%%PYMAPDLVERSION%%.0/pymapdl-Documentation-%%PYMAPDLVERSION%%.0.pdf


.. #Python
.. _using_venv: https://docs.python.org/3/library/venv.html
Expand Down
Loading