Skip to content

Commit cb99f3f

Browse files
committed
deploy: 9526c3f
1 parent 0b3b70e commit cb99f3f

File tree

83 files changed

+68
-44
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+68
-44
lines changed

.doctrees/CONTRIBUTING.doctree

1.04 KB
Binary file not shown.

.doctrees/TRANSLATING.doctree

0 Bytes
Binary file not shown.
Binary file not shown.

.doctrees/environment.pickle

69 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

.doctrees/tests/run-tests.doctree

0 Bytes
Binary file not shown.
8 Bytes
Binary file not shown.

CONTRIBUTING.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -678,6 +678,12 @@ <h3>How to build the guide locally<a class="headerlink" href="#how-to-build-the-
678678
</div>
679679
<p>To see the guide built locally, open the file <code class="docutils literal notranslate"><span class="pre">_build/html/index.html</span></code> in your browser.</p>
680680
</li>
681+
<li><p><code class="docutils literal notranslate"><span class="pre">docs-linkcheck</span></code>: this session checks that links in documentation work</p>
682+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>nox<span class="w"> </span>-e<span class="w"> </span>docs-linkcheck
683+
</pre></div>
684+
</div>
685+
<p>If the tests fail, you will see logs in the terminal and in <code class="docutils literal notranslate"><span class="pre">_build/linkcheck_output/output.txt</span></code>.</p>
686+
</li>
681687
<li><p><code class="docutils literal notranslate"><span class="pre">docs-test</span></code>: this session runs the tests for the guide.</p>
682688
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>nox<span class="w"> </span>-e<span class="w"> </span>docs-test
683689
</pre></div>

TRANSLATING.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_sources/CONTRIBUTING.md.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,12 @@ There are different sessions in nox related to building the docs: `docs`, `docs-
188188
```
189189
To see the guide built locally, open the file `_build/html/index.html` in your browser.
190190

191+
- `docs-linkcheck`: this session checks that links in documentation work
192+
```bash
193+
nox -e docs-linkcheck
194+
```
195+
If the tests fail, you will see logs in the terminal and in `_build/linkcheck_output/output.txt`.
196+
191197
- `docs-test`: this session runs the tests for the guide.
192198
```bash
193199
nox -e docs-test

0 commit comments

Comments
 (0)