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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摑 Make Sphinx strict about broken references #2168

Merged
merged 2 commits into from Aug 21, 2021

Conversation

webknjaz
Copy link
Contributor

@webknjaz webknjaz commented Aug 20, 2021

I noticed that the current Sphinx setup doesn't care about broken references. As a result, a few have slipped in, over time. This patch helps make sure that this won't happen again.

Contribution checklist:

(also see CONTRIBUTING.rst for details)

  • wrote descriptive pull request text
  • added/updated test(s)
  • updated/extended the documentation
  • added relevant issue keyword
    in message body
  • added news fragment in changelog folder
    • fragment name: <issue number>.<type>.rst for example (588.bugfix.rst)
    • <type> is must be one of bugfix, feature, deprecation,breaking, doc, misc
    • if PR has no issue: consider creating one first or change it to the PR number after creating the PR
    • "sign" fragment with "by :user:<your username>"
    • please use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files - by :user:superuser."
    • also see examples
  • added yourself to CONTRIBUTORS (preserving alphabetical order)

webknjaz added a commit to webknjaz/tox that referenced this pull request Aug 20, 2021
@webknjaz webknjaz force-pushed the maintenance/nitpicky-sphinx branch from 36a1946 to e2126aa Compare Aug 20, 2021
@webknjaz webknjaz force-pushed the maintenance/nitpicky-sphinx branch from e2126aa to dcf823a Compare Aug 20, 2021
@gaborbernat gaborbernat merged commit 3dbc21f into tox-dev:master Aug 21, 2021
31 checks passed
bors bot added a commit to meilisearch/meilisearch-python that referenced this pull request Aug 23, 2021
308: Bump tox from 3.24.2 to 3.24.3 r=alallema a=dependabot[bot]

Bumps [tox](https://github.com/tox-dev/tox) from 3.24.2 to 3.24.3.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href="https://github.com/tox-dev/tox/blob/master/docs/changelog.rst">tox's changelog</a>.</em></p>
<blockquote>
<p>v3.24.3 (2021-08-21)
Bugfixes
^^^^^^^^</p>
<ul>
<li><code>--parallel</code> reports now show ASCII OK/FAIL/SKIP lines when full Unicode output is not available - by :user:<code>brettcs</code>
<code>[#1421](tox-dev/tox#1421) &lt;https://github.com/tox-dev/tox/issues/1421&gt;</code>_</li>
</ul>
<p>Miscellaneous
^^^^^^^^^^^^^</p>
<ul>
<li>Started enforcing valid references in Sphinx docs -- :user:<code>webknjaz</code>
<code>[#2168](tox-dev/tox#2168) &lt;https://github.com/tox-dev/tox/issues/2168&gt;</code>_</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/tox-dev/tox/commit/db3149ecd44c0b03418386074a3b07de2914a14d"><code>db3149e</code></a> release 3.24.3</li>
<li><a href="https://github.com/tox-dev/tox/commit/8f5ca1165749efd71d4d3afc19285a9257fe1279"><code>8f5ca11</code></a> ASCII output for --parallel report lines (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2164">#2164</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/e1f1826d0533c3b45cbe72c9210ae0cca3ad2181"><code>e1f1826</code></a> 鈾 Fix the rendering of PR templates (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2169">#2169</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/3dbc21f47ed2fe07dce09770e02e692e1c0e3045"><code>3dbc21f</code></a> 馃摑 Make Sphinx strict about broken references (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2168">#2168</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/63c98c2ff2bf6506499ed73e8c0806df79351951"><code>63c98c2</code></a> 馃摑 Document when <code>{tty}</code> was added (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2166">#2166</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/29a1ca98b5f6fc9d6adf4200c2fb566a0319cd65"><code>29a1ca9</code></a> 馃悰 Fix the last version+date underline in changelog (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2165">#2165</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/8c8a29e34886f45f7e3b86dc62a1723aa14fd369"><code>8c8a29e</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2163">#2163</a> from tox-dev/release-3.24.2</li>
<li>See full diff in <a href="https://github.com/tox-dev/tox/compare/3.24.2...3.24.3">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=tox&package-manager=pip&previous-version=3.24.2&new-version=3.24.3)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR by commenting ``@dependabot` rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- ``@dependabot` rebase` will rebase this PR
- ``@dependabot` recreate` will recreate this PR, overwriting any edits that have been made to it
- ``@dependabot` merge` will merge this PR after your CI passes on it
- ``@dependabot` squash and merge` will squash and merge this PR after your CI passes on it
- ``@dependabot` cancel merge` will cancel a previously requested merge and block automerging
- ``@dependabot` reopen` will reopen this PR if it is closed
- ``@dependabot` close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- ``@dependabot` ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
bors bot added a commit to meilisearch/docs-scraper that referenced this pull request Aug 25, 2021
148: Bump tox from 3.23.0 to 3.24.3 r=bidoubiwa a=dependabot[bot]

Bumps [tox](https://github.com/tox-dev/tox) from 3.23.0 to 3.24.3.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href="https://github.com/tox-dev/tox/blob/master/docs/changelog.rst">tox's changelog</a>.</em></p>
<blockquote>
<p>v3.24.3 (2021-08-21)
Bugfixes
^^^^^^^^</p>
<ul>
<li><code>--parallel</code> reports now show ASCII OK/FAIL/SKIP lines when full Unicode output is not available - by :user:<code>brettcs</code>
<code>[#1421](tox-dev/tox#1421) &lt;https://github.com/tox-dev/tox/issues/1421&gt;</code>_</li>
</ul>
<p>Miscellaneous
^^^^^^^^^^^^^</p>
<ul>
<li>Started enforcing valid references in Sphinx docs -- :user:<code>webknjaz</code>
<code>[#2168](tox-dev/tox#2168) &lt;https://github.com/tox-dev/tox/issues/2168&gt;</code>_</li>
</ul>
<h2>v3.24.2 (2021-08-18)</h2>
<p>Bugfixes
^^^^^^^^</p>
<ul>
<li>include <code>LC_ALL</code> to implicit list of passenv variables - by :user:<code>ssbarnea</code>
<code>[#2162](tox-dev/tox#2162) &lt;https://github.com/tox-dev/tox/issues/2162&gt;</code>_</li>
</ul>
<h2>v3.24.1 (2021-07-31)</h2>
<p>Bugfixes
^^^^^^^^</p>
<ul>
<li><code>get_requires_for_build_sdist</code> hook (PEP 517) is assumed to return an empty list if left unimplemented by the backend build system - by :user:<code>oczkoisse</code>
<code>[#2130](tox-dev/tox#2130) &lt;https://github.com/tox-dev/tox/issues/2130&gt;</code>_</li>
</ul>
<p>Documentation
^^^^^^^^^^^^^</p>
<ul>
<li>The documentation of <code>install_command</code> now also mentions that you can provide arbitrary commands - by :user:<code>jugmac00</code>
<code>[#2081](tox-dev/tox#2081) &lt;https://github.com/tox-dev/tox/issues/2081&gt;</code>_</li>
</ul>
<h2>v3.24.0 (2021-07-14)</h2>
<p>Bugfixes
^^^^^^^^</p>
<ul>
<li><code>--devenv</code> no longer modifies the directory in which the <code>.tox</code> environment is provisioned - by :user:<code>isaac-ped</code>
<code>[#2065](tox-dev/tox#2065) &lt;https://github.com/tox-dev/tox/issues/2065&gt;</code>_</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/tox-dev/tox/commit/db3149ecd44c0b03418386074a3b07de2914a14d"><code>db3149e</code></a> release 3.24.3</li>
<li><a href="https://github.com/tox-dev/tox/commit/8f5ca1165749efd71d4d3afc19285a9257fe1279"><code>8f5ca11</code></a> ASCII output for --parallel report lines (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2164">#2164</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/e1f1826d0533c3b45cbe72c9210ae0cca3ad2181"><code>e1f1826</code></a> 鈾 Fix the rendering of PR templates (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2169">#2169</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/3dbc21f47ed2fe07dce09770e02e692e1c0e3045"><code>3dbc21f</code></a> 馃摑 Make Sphinx strict about broken references (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2168">#2168</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/63c98c2ff2bf6506499ed73e8c0806df79351951"><code>63c98c2</code></a> 馃摑 Document when <code>{tty}</code> was added (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2166">#2166</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/29a1ca98b5f6fc9d6adf4200c2fb566a0319cd65"><code>29a1ca9</code></a> 馃悰 Fix the last version+date underline in changelog (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2165">#2165</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/8c8a29e34886f45f7e3b86dc62a1723aa14fd369"><code>8c8a29e</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2163">#2163</a> from tox-dev/release-3.24.2</li>
<li><a href="https://github.com/tox-dev/tox/commit/3dc01d5c0f3ec51583de6c990107f12c608d82f6"><code>3dc01d5</code></a> release 3.24.2</li>
<li><a href="https://github.com/tox-dev/tox/commit/bb609f5acfc580588925367b00533bf808e9d4c1"><code>bb609f5</code></a> Add LC_ALL to implicit tox passenv (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2162">#2162</a>)</li>
<li><a href="https://github.com/tox-dev/tox/commit/8ded7b72cb7dbb8da3a3eccfe6f9a099edbcde5f"><code>8ded7b7</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://github-redirect.dependabot.com/tox-dev/tox/issues/2149">#2149</a>)</li>
<li>Additional commits viewable in <a href="https://github.com/tox-dev/tox/compare/3.23.0...3.24.3">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=tox&package-manager=pip&previous-version=3.23.0&new-version=3.24.3)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR by commenting ``@dependabot` rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- ``@dependabot` rebase` will rebase this PR
- ``@dependabot` recreate` will recreate this PR, overwriting any edits that have been made to it
- ``@dependabot` merge` will merge this PR after your CI passes on it
- ``@dependabot` squash and merge` will squash and merge this PR after your CI passes on it
- ``@dependabot` cancel merge` will cancel a previously requested merge and block automerging
- ``@dependabot` reopen` will reopen this PR if it is closed
- ``@dependabot` close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- ``@dependabot` ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants