Referencing the PDF in the docs

ansys · Nov 7, 2023 · 619fcf7 · 619fcf7
1 parent c1ea52c
commit 619fcf7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -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:

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -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

diff --git a/doc/source/links.rst b/doc/source/links.rst
@@ -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