Skip to content
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.

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

Raise warnings if a relative link is referenced with the external link directive #532

Open
dgarcia360 opened this issue Jul 26, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@dgarcia360
Copy link
Collaborator

dgarcia360 commented Jul 26, 2022

Motivation

We noticed in https://github.com/scylladb/scylla/pull/11092/files that some documentation projects such as scylla-docs were using the external link directive for linking internal docs.

For example:

  * `Scylla Housekeeping and how to disable it <disable-housekeeping>`_

Instead of:

 * :doc:`Scylla Housekeeping and how to disable it <disable-housekeeping>`

While the link might work in the local environment, it might not work in production since the URL of the link changes due to multiversion.

Proposal

Raise a new warning if there are internal docs referenced using the external links directive.

@dgarcia360 dgarcia360 self-assigned this Jul 26, 2022
@dgarcia360 dgarcia360 added this to the 1.2.3 milestone Jul 26, 2022
@dgarcia360 dgarcia360 modified the milestones: 1.2.3, 1.3.1 Aug 12, 2022
@dgarcia360 dgarcia360 removed this from the 1.3.1 milestone Mar 28, 2023
@dgarcia360 dgarcia360 removed their assignment Sep 12, 2023
@dgarcia360 dgarcia360 added the enhancement New feature or request label Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant