Skip to content

simplify #1

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 23, 2019
Merged

simplify #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 7 additions & 23 deletions committing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,35 +202,19 @@ 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::

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

In addition to inline reST, news entries also support the usage of
`Sphinx roles <https://devguide.python.org/documenting/#id4>`_. Several
commonly used roles include :func:, :class:, and :meth:. When a
corresponding entry is found within the documentation, the text within
the role is converted into a hyperlink. Example news entry with Sphinx::
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 :func:`os.chdir` fails inside
:func:`test.support.temp_cwd`. Patch by Chris Jerdonek.

The inline Sphinx roles can be used to assist readers in finding more
information and context on the changes made. If the inline link does not
provide additional context, an inline reST code block can be used instead::

``<object>``
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>`.

Before using any Sphinx roles, ensure that a corresponding entry exists
within the documentation. When adding rich formatting to news entries,
use the netlify deploy preview to verify that the documentation was
appropriately modified. Alternatively, `make html
<https://devguide.python.org/documenting/#using-make-make-bat>`_
can be used instead.
While Sphinx roles can be beneficial to readers, they are not required.
Inline ````code blocks```` can be used instead.

The Sphinx roles can be beneficial to readers, but they are not required.
Inline code blocks can be used as a viable substitute.

Working with Git_
-----------------
Expand Down
3 changes: 3 additions & 0 deletions documenting.rst
View file
Open in desktop
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