Skip to content

Updated rtd links (latest -> main) #416

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.

Sign up for GitHub

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

Merged
prabhuramachandran merged 2 commits into from
May 31, 2025
Merged

Updated rtd links (latest -> main) #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e97b72
doc: fixed rtd badge in readme
nauaneed May 30, 2025
db8a477
doc: updated link to compyle docs
nauaneed May 30, 2025
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
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ The latest documentation for PySPH is available at
:target: https://github.com/pypr/pysph/actions/workflows/tests.yml
.. |MPI Build Status| image:: https://github.com/pypr/pysph/actions/workflows/zoltan-tests.yml/badge.svg
:target: https://github.com/pypr/pysph/actions/workflows/zoltan-tests.yml
.. |Documentation Status| image:: https://readthedocs.org/projects/pysph/badge/?version=latest
:target: https://pysph.readthedocs.io/en/latest/?badge=latest
.. |Documentation Status| image:: https://readthedocs.org/projects/pysph/badge/?version=main
:target: https://pysph.readthedocs.io/en/main/?badge=main
Comment on lines +24 to +25
Copy link

Copilot AI May 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] You could abstract the RTD version into a variable or use a Sphinx substitution to keep badge URLs in sync and minimize future version updates.

Suggested change
.. |Documentation Status| image:: https://readthedocs.org/projects/pysph/badge/?version=main
:target: https://pysph.readthedocs.io/en/main/?badge=main
.. |Documentation Status| image:: https://readthedocs.org/projects/pysph/badge/?version=|rtd_version|
:target: https://pysph.readthedocs.io/en/|rtd_version|/?badge=|rtd_version|

Copilot uses AI. Check for mistakes.
:alt: Documentation Status


Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ installing the OpenMP support for clang. This can be done with brew_ using::

`LLVM <https://formulae.brew.sh/formula/llvm>`_ can also be installed using
brew_, likewise. Once this is done, you can use the following
`compyle config <https://compyle.readthedocs.io/en/latest/installation.html#config>`_::
`compyle config <https://compyle.readthedocs.io/en/main/installation.html#config>`_::
Copy link

Copilot AI May 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider using a Sphinx variable or substitution for the RTD version in this URL to avoid having to update hard-coded links whenever the default branch changes.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

@nauaneed nauaneed May 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How?


import os
os.environ['CC'] = '/opt/homebrew/opt/llvm@15/bin/clang'
Expand Down
Loading