Skip to content

Commit

Permalink
fix: linkchecker and cheatsheet links (#3589)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
  • Loading branch information
germa89 and pyansys-ci-bot authored Nov 29, 2024
1 parent 2bfc164 commit 89bd649
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
1 change: 1 addition & 0 deletions doc/changelog.d/3589.fixed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fix: linkchecker and cheatsheet links
10 changes: 6 additions & 4 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand All @@ -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
]
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting_started/learning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Downloads

.. jinja:: cheat_sheet

- View and download :download:`PyMAPDL cheatsheet <https://mapdl.docs.ansys.com/version/{{ version }}/_static/cheatsheet.pdf>`
- View and download :download:`PyMAPDL cheatsheet <https://github.com/ansys/pymapdl/blob/gh-pages/version/{{ version }}/_static/cheat_sheet.pdf>`
to help you to learn PyMAPDL.

- Visit :ref:`ref_examples` to learn how PyMAPDL can be used to solve different real problems.
Expand Down
5 changes: 3 additions & 2 deletions doc/source/getting_started/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <pymapdl_cheat_sheet>`_ 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 <https://github.com/ansys/pymapdl/blob/gh-pages/version/{{ version }}/_static/cheat_sheet.pdf>`.
This one-page reference provides syntax rules and commands for using PyMAPDL.

On the `PyMAPDL Issues <https://github.com/ansys/pymapdl/issues>`_ page,
you can create issues to report bugs and request new features. On the `PyMAPDL Discussions
Expand Down

0 comments on commit 89bd649

Please sign in to comment.