Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a19887a

Browse files
aerosmethane
authored andcommitted
Update the NEWS example to use Sphinx roles (#525)
1 parent 38880a2 commit a19887a

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

committing.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,18 @@ So a file name may be
202202
The contents of a news file should be valid reStructuredText. An 80 character
203203
column width should be used. There is no indentation or leading marker in the
204204
file (e.g. ``-``). There is also no need to start the entry with the issue
205-
number as it's part of the file name itself. Example news entry::
205+
number as it's part of the file name itself. You can use
206+
:ref:`inline markups <rest-inline-markup>` too. Example news entry::
206207

207-
Fix warning message when ``os.chdir()`` fails inside
208-
``test.support.temp_cwd()``. Patch by Chris Jerdonek.
208+
Fix warning message when :func:`os.chdir` fails inside
209+
:func:`test.support.temp_cwd`. Patch by Chris Jerdonek.
210+
211+
The inline Sphinx roles like ``:func:`` can be used to assist readers in finding
212+
more information. You can build html and verify that the link target is
213+
appropriate by using :ref:`make html <building-using-make>`.
214+
215+
While Sphinx roles can be beneficial to readers, they are not required.
216+
Inline ````code blocks```` can be used instead.
209217

210218

211219
Working with Git_

documenting.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -902,6 +902,7 @@ file :file:`example.py`, use::
902902
The file name is relative to the current file's path. Documentation-specific
903903
include files should be placed in the ``Doc/includes`` subdirectory.
904904

905+
.. _rest-inline-markup:
905906

906907
Inline markup
907908
-------------
@@ -1531,6 +1532,8 @@ created using ``make venv``), so that the Makefile can find the
15311532
``sphinx-build`` with the ``SPHINXBUILD`` :command:`make` variable.
15321533

15331534

1535+
.. _building-using-make:
1536+
15341537
Using make / make.bat
15351538
---------------------
15361539

0 commit comments

Comments
 (0)