Skip to content

#406 Update the release docs after the last release.#407

Merged
hynek merged 10 commits intotrunkfrom
406-release-docs
Aug 30, 2022
Merged

#406 Update the release docs after the last release.#407
hynek merged 10 commits intotrunkfrom
406-release-docs

Conversation

@adiroiban
Copy link
Copy Markdown
Member

@adiroiban adiroiban commented Aug 29, 2022

Description

Fixes #406

Just the updates of the docs based on the steps followed during the last release.

Added the release docs to the normal docs so that we can preview the rendering via RTD.

@adiroiban adiroiban requested a review from a team as a code owner August 29, 2022 21:36
@codecov
Copy link
Copy Markdown

codecov bot commented Aug 29, 2022

Codecov Report

Merging #407 (f1b05b1) into trunk (55593d4) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            trunk     #407   +/-   ##
=======================================
  Coverage   97.85%   97.85%           
=======================================
  Files          22       22           
  Lines        1400     1400           
  Branches      130      130           
=======================================
  Hits         1370     1370           
  Misses         15       15           
  Partials       15       15           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Copy Markdown
Member

@hynek hynek left a comment

Choose a reason for hiding this comment

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

Some nits, can't say much about the content.

But the docs build is failing due to this line:

/home/docs/checkouts/readthedocs.org/user_builds/towncrier/envs/407/bin/python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2 jinja2<3.1.0

I'm not sure where those pins are coming from – is there something in the web interface? (Admin → Advanced Settings → Default settings)

The problem is that it uses an ancient sphinx which needs a jinja2<3 pin (and markupsafe<2.1).

@adiroiban adiroiban marked this pull request as draft August 30, 2022 11:24
@adiroiban adiroiban marked this pull request as ready for review August 30, 2022 11:43
@adiroiban adiroiban requested a review from a team August 30, 2022 11:44
@adiroiban
Copy link
Copy Markdown
Member Author

adiroiban commented Aug 30, 2022

Thanks for the review.

I have applied your suggestions.

The content is more for the next maintainer to know how the previous releases were done.

I tried to add a tox to build the docs on your local system... and cleaned some docs errors.

It looks like GitHub CODEOWNER PR review only works for the first review request, and not for re-review request.

This is ready for another review.

The docs in HTML format https://towncrier--407.org.readthedocs.build/en/407/release.html

@hynek hynek enabled auto-merge August 30, 2022 13:03
@hynek hynek merged commit dd47c1f into trunk Aug 30, 2022
@hynek hynek deleted the 406-release-docs branch August 30, 2022 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the updated release process

2 participants