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.

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

Jump to bottom

[10034] Update the release process documentation. #1465

Merged
merged 4 commits into from Dec 24, 2020
Merged

[10034] Update the release process documentation. #1465

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0ad2467
Initial release docs update.
adiroiban Oct 23, 2020
e983d1d
Fix narrative docs.
adiroiban Oct 23, 2020
c8f9cbf
Merge trunk.
adiroiban Dec 24, 2020
ed0583d
Force updating the fragment.
adiroiban Dec 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 9 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE
View file
Open in desktop
@@ -1,14 +1,22 @@
## Scope and purpose

Add a few words about why this PR is needed and what is its scope.

Add mentions of things that are not covered here and are planed to be done
in separate PRs.


## Remove this section

Please have a look at [our developer documentation](https://twistedmatrix.com/trac/wiki/TwistedDevelopment#SubmittingaPatch) before submitting your Pull Request.

Please note that the trac ticket, news fragment, and review submission portions of this process apply to *all* pull requests, no matter how small; if you don't do them, it's likely that nobody will even notice your PR needs a review.


Copy link
Member

Choose a reason for hiding this comment

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

Suggested change

Copy link
Member Author

Choose a reason for hiding this comment

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

This was intentional. The reasoning is.

2 empty lines before a section title. 1 empty line after a section title

In this way, I find it easier to detect sections :)

## Contributor Checklist:

* [ ] The associated ticket in Trac is here: https://twistedmatrix.com/trac/ticket/<!-- Create a new one at https://twistedmatrix.com/trac/newticket and replace this comment with the ticket number. -->
* [ ] I ran `tox -e lint` to format my patch to meet the [Twisted Coding Standard](https://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html)
graingert marked this conversation as resolved.
Show resolved Hide resolved
* [ ] I ran additional checks listed at [Getting Your Patch Accepted](https://twistedmatrix.com/trac/wiki/TwistedDevelopment#GettingYourPatchAccepted)
* [ ] I have created a newsfragment in src/twisted/newsfragments/ (see: [News files](https://twistedmatrix.com/trac/wiki/ReviewProcess#Newsfiles))
* [ ] I have updated the automated tests.
* [ ] I have submitted the associated Trac ticket for review by adding the word `review` to the keywords field in Trac, and putting a link to this PR in the comment; it shows up in https://twisted.reviews/ now.
5 changes: 4 additions & 1 deletion .readthedocs.yml
View file
Open in desktop
@@ -1,7 +1,10 @@
version: 2

sphinx:
fail_on_warning: true
# This should not fail on errors.
# We have a separate build process which fails on errors and shows all
# the errors in one go.
fail_on_warning: false
Copy link
Member

Choose a reason for hiding this comment

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

I think it's worth enabling this once we can ignore the warnings in ToC sphinx-doc/sphinx#8289

(Sphinx 3.3.0)

Copy link
Member Author

Choose a reason for hiding this comment

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

Right now, it is blocked by a different issue.

When fail on warnings is True, read the docs will not build the HTML files..so you can't check the partial output.

I was expecting that this PR will fix it readthedocs/readthedocs.org#7251

but when sphinx build fails, I still don't get HTML files


formats:
- pdf
Expand Down