From 89bd6494e39d4d7964bc7c76f7a48fde969b1603 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Fri, 29 Nov 2024 20:00:13 +0100 Subject: [PATCH] fix: linkchecker and cheatsheet links (#3589) * fix: agent * fix: cheatsheet links * chore: adding changelog file 3589.fixed.md [dependabot-skip] * fix: skip checking ansys websites * Update doc/source/conf.py --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> --- doc/changelog.d/3589.fixed.md | 1 + doc/source/conf.py | 10 ++++++---- doc/source/getting_started/learning.rst | 2 +- doc/source/getting_started/project.rst | 5 +++-- 4 files changed, 11 insertions(+), 7 deletions(-) create mode 100644 doc/changelog.d/3589.fixed.md diff --git a/doc/changelog.d/3589.fixed.md b/doc/changelog.d/3589.fixed.md new file mode 100644 index 0000000000..bc7f39a54b --- /dev/null +++ b/doc/changelog.d/3589.fixed.md @@ -0,0 +1 @@ +fix: linkchecker and cheatsheet links \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 235c3db45b..d6b87ea018 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -205,7 +205,7 @@ with open("links.rst") as f: rst_epilog += f.read() -rst_epilog = rst_epilog.replace("%%VERSION%%", "v231") +rst_epilog = rst_epilog.replace("%%VERSION%%", "v242") rst_epilog = rst_epilog.replace("%%PYMAPDLVERSION%%", release) @@ -219,8 +219,10 @@ linkcheck_ignore = [ "https://github.com/ansys/pymapdl/*", "https://mapdl.docs.pyansys.com/*", - "https://ansysaccount.b2clogin.com/*", # behind payfirewall - "https://ansyshelp.ansys.com/*", # behind payfirewall + "https://www.ansys.com/*", # behind firewall + "https://download.ansys.com/*", # behind firewall + "https://ansysaccount.b2clogin.com/*", # behind authentication + "https://ansyshelp.ansys.com/*", # behind authentication "https://forum.ansys.com/forums/*", # It is detected as broken "https://courses.ansys.com/*", # It is detected as broken ] @@ -239,7 +241,7 @@ f"https://github.com/ansys/pymapdl/releases/tag/v{__version__}" ) -user_agent = """curl https://www.ansys.com -A "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.3""" +user_agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36 Edg/123.0.2420.81" # noqa: E501 # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" diff --git a/doc/source/getting_started/learning.rst b/doc/source/getting_started/learning.rst index 5ab22e88b3..4e11737715 100644 --- a/doc/source/getting_started/learning.rst +++ b/doc/source/getting_started/learning.rst @@ -40,7 +40,7 @@ Downloads .. jinja:: cheat_sheet - - View and download :download:`PyMAPDL cheatsheet ` + - View and download :download:`PyMAPDL cheatsheet ` to help you to learn PyMAPDL. - Visit :ref:`ref_examples` to learn how PyMAPDL can be used to solve different real problems. diff --git a/doc/source/getting_started/project.rst b/doc/source/getting_started/project.rst index 9bf7d7d202..e0d7a29554 100644 --- a/doc/source/getting_started/project.rst +++ b/doc/source/getting_started/project.rst @@ -174,8 +174,9 @@ In the upper right corner of the documentation's title bar, there is an option f viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions. -You can also `download `_ the PyMAPDL cheat sheet. This one-page reference provides -syntax rules and commands for using PyMAPDL. +You can also download the +:download:`PyMAPDL cheat sheet `. +This one-page reference provides syntax rules and commands for using PyMAPDL. On the `PyMAPDL Issues `_ page, you can create issues to report bugs and request new features. On the `PyMAPDL Discussions