Skip to content

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

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
methane merged 13 commits into from
Aug 23, 2019
Merged

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

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3a36921
Add Sphinx roles to 'What's New and News Entries'
aeros Aug 16, 2019
3537389
Fix spacing
aeros Aug 16, 2019
75f32b1
Update committing.rst
aeros Aug 16, 2019
aa8006a
Fix inline reST link
aeros Aug 16, 2019
a00d45d
Remove parens from Sphinx role
aeros Aug 16, 2019
5eb7d60
Fix grammar
aeros Aug 16, 2019
294cd03
Improve wording
aeros Aug 16, 2019
87ab9fb
Adjust wording
aeros Aug 17, 2019
4915d76
Adjust wording and add "What's New" section.
aeros Aug 18, 2019
ed22f08
Add suggestions from Inada Naoki
aeros Aug 18, 2019
fd20a1c
Update for netlify deploy preview
aeros Aug 21, 2019
b13ca84
simplify
methane Aug 22, 2019
8f98858
Add suggestions from Inada Naoki
aeros Aug 23, 2019
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
Prev Previous commit
Next Next commit
Update for netlify deploy preview
  • Loading branch information
@aeros
aeros authored Aug 21, 2019
commit fd20a1c71c27cda8b53653314cfdd346d66bd0c7
9 changes: 5 additions & 4 deletions committing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,10 +223,11 @@ provide additional context, an inline reST code block can be used instead::
``<object>``

Before using any Sphinx roles, ensure that a corresponding entry exists
within the documentation. When adding rich formatting to news entries
`build the HTML locally using make
<https://devguide.python.org/documenting/#using-make-make-bat>`_ to
verify that the links lead to the correct locations.
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.

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