ansys / ansys/pystk

Re-enable linkcheck for links to examples

Open
#657 0 comments 0 reactions 0 assignees Claimed by @jorgepiloto View on GitHub
docs
Dominant language
Python
Stars
37
Forks
7
Avg merge
1d 5h
Merged PRs (30d)
19

Description

The current approach to link to examples within the documentation breaks the linkcheck (and the documentation build) as the linked file is not available at runtime, even though it is available at build time.

See [this conversation](https://github.com/ansys-internal/pystk/pull/654#discussion_r2001706173) for an example.

Once a new approach is employed, the directive to ignore links to examples in the linkcheck should be removed.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named; start by reviewing linked pull request #1098 and the example conversation in pull request #654. Locate the directive that ignores links to examples and the documentation linkcheck configuration. Done means a new example-linking approach works at runtime and build time, and the ignore directive is removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.