Skip to content

docs: link references to external software - #491

Merged
Joseph-Edwards merged 2 commits into
mainfrom
codex/link-software-in-docs
Sep 11, 2026
Merged

Joseph-Edwards merged 2 commits into
mainfrom
codex/link-software-in-docs

Conversation

@james-d-mitchell

Copy link
Copy Markdown
Member

Software names in the documentation and binding docstrings often appear as plain text. Add shared link targets for GAP, ACE, Eigen, Cython, cppyy, pip, mamba, Anaconda and Miniconda, and use them at the existing mentions. Also link missing HPCombi and libsemigroups references and standardise the existing ACE and Eigen destinations.

Validation: rebuilt the extension on this branch; the full Sphinx HTML build passed with warnings treated as errors; shared external link checks, rendered HTML link checks, docstring indentation checks and git diff --check passed.

AI disclosure: OpenAI Codex authored these changes and this PR description at James Mitchell's request. The commit records Codex as author and James Mitchell as committer.

Fixes #464.

@james-d-mitchell james-d-mitchell added the documentation Improvements or additions to documentation label Sep 8, 2026

@Joseph-Edwards Joseph-Edwards left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I am happy with most of the changes in this PR, but there are a few small tweaks that I think should be made.

We probably need to have a full pass through the installation page and update it where necessary, but that's probably for a different PR.

Comment thread docs/source/_static/links.rst Outdated
Comment thread docs/source/_static/links.rst
Comment thread docs/source/install.rst Outdated
Comment thread docs/source/install.rst Outdated
Comment thread docs/source/install.rst Outdated
Comment thread docs/source/install.rst
Comment thread src/libsemigroups_pybind11/hpcombi.py Outdated
@james-d-mitchell
james-d-mitchell force-pushed the codex/link-software-in-docs branch 3 times, most recently from 2d1974b to 8f0313c Compare September 9, 2026 10:31
@james-d-mitchell
james-d-mitchell force-pushed the codex/link-software-in-docs branch from 8f0313c to 60c2ed4 Compare September 11, 2026 16:46
@Joseph-Edwards
Joseph-Edwards merged commit 22f2025 into main Sep 11, 2026
28 checks passed
@james-d-mitchell
james-d-mitchell deleted the codex/link-software-in-docs branch September 12, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add links to the doc for GAP, ACE, and so on

3 participants