Collect usual hyperlinks in a common links.rst

[jorgepiloto]

By creating a links.rst file and taking advantage of the .. include:: path/to/file.rst directive, it would be possible to reduce common links across different pages. This links.rst file should be included at the end of the doc/source/index.rst file to ensure that all pages have access to the links.

• Create source/links/ directory.
• Create source/links/pep.rst
• Create source/links/tools.rst
• Create source/links/pyansys.rst

Make sure to ignore previous files using the exclude_patterns directive so they do not get rendered by Sphinx.

[akaszynski]

Didn't know about this. Cool!

[PipKat]

This is very cool!

[jorgepiloto]

It is possible to look for all documentation links using all the power of grep command:

grep -o -E "\`(.*?)\`_" -r doc/source

[PipKat]

@jorgepiloto Where do you launch this grep command? From Windows PowerShell or Anaconda PowerShell?

[jorgepiloto]

Hi @PipKat! The grep command is only available in Linux systems. If you want to access this command, you must install WSL and the Windows Terminal.

I guess there are alternatives for grep in PowerShell, but not sure at all...

[PipKat]

@jorgepiloto I think I'll leave running this to you as I have no experience with Linux systems. Thanks, though, for discovering such a check!

[jorgepiloto]

Pasting here this command for finding all substitution links. It will be useful in the future:

grep --exclude "links.rst" -h -o -E "\.\. \_{1}(.*?)" -r doc/source

[jorgepiloto]

This tool seems useful for checking links health, see https://github.com/jupyterlab/pytest-check-links

[germa89]

Interesting...

• Create source/links/pep.rst
• Create source/links/tools.rst
• Create source/links/pyansys.rst

What are the other files for?

[jorgepiloto]

What are the other files for?

I thought it would be useful to collect all related PEP links within a source/links/pep.rst. Then, by using the .. source:: path/to/file.rst those could be used on demand. However, this introduced a circular dependency which did not allowed to build the documentation.

[germa89]

@jorgepiloto are we still doing this?

[germa89]

https://stackoverflow.com/questions/61688403/can-i-keep-all-my-external-links-in-a-separate-file-with-sphinx

[pyansys-automation]

Hello @MaxJPRey, @clatapie, @Revathyvenugopal162, @RobPasMue, @germa89, @jorgepiloto!
This issue has been open for over a year and has had no updates in the past 8 months. If it is still relevant, please provide an update. Otherwise, consider closing it to help keep the issue tracker clean.

If this issue needs to remain open, please comment below with @pyansys-automation never close issue to prevent it from being automatically closed.

If you want this repository to be excluded from this automated maintenance process, please let us know by filling in the opt-out request form.