Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions newsfragments/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ Your text can use all the same markup that we use in our Sphinx docs.
For example, you can use double-backticks to mark code snippets, or
single-backticks to link to a function/class/module.

To check syntax and references locally, install the documentation dependencies
in your development environment and run the existing Sphinx dummy builder:

.. code-block:: shell

python -m pip install -r docs-requirements.txt
make -C docs dummy SPHINXOPTS="-E -W --keep-going"

This checks the assembled changelog and documentation without generating HTML.
Warnings cause the command to fail; ``-E`` ensures edited fragments are reread.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we need to provide -W for this? And the description for -E doesn't help me understand why that's there.


To check how your formatting looks, the easiest way is to make the PR,
and then after the CI checks run, click on the "Read the Docs build"
details link, and navigate to the release history page.
Loading