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

Expand "What's New and News Entries" to include Sphinx #525

Merged
merged 13 commits into from
Aug 23, 2019
14 changes: 11 additions & 3 deletions committing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,18 @@ So a file name may be
The contents of a news file should be valid reStructuredText. An 80 character
column width should be used. There is no indentation or leading marker in the
file (e.g. ``-``). There is also no need to start the entry with the issue
number as it's part of the file name itself. Example news entry::
number as it's part of the file name itself. You can use
:ref:`inline markups <rest-inline-markup>` too. Example news entry::

Fix warning message when ``os.chdir()`` fails inside
``test.support.temp_cwd()``. Patch by Chris Jerdonek.
Fix warning message when :func:`os.chdir` fails inside
:func:`test.support.temp_cwd`. Patch by Chris Jerdonek.

The inline Sphinx roles like ``:func:`` can be used to assist readers in finding
more information. You can build html and verify that the link target is
appropriate by using :ref:`make html <building-using-make>`.

While Sphinx roles can be beneficial to readers, they are not required.
Inline ````code blocks```` can be used instead.


Working with Git_
Expand Down
3 changes: 3 additions & 0 deletions documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -902,6 +902,7 @@ file :file:`example.py`, use::
The file name is relative to the current file's path. Documentation-specific
include files should be placed in the ``Doc/includes`` subdirectory.

.. _rest-inline-markup:

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


.. _building-using-make:

Using make / make.bat
---------------------

Expand Down