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

Add instructions for publishing new releases #52

Merged
merged 4 commits into from
Aug 24, 2023

Conversation

willGraham01
Copy link
Contributor

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

Standardise the methods we use to create new package releases.

What does this PR do?

Adds instructions for publishing a new release to the developer documentation.

Does this PR require an update to the documentation?

Meta-question.

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@adamltyson
Copy link
Member

Looks great, thanks @willGraham01. I made a couple of tiny changes to match the formatting of the rest of the website (and stop sphinx complaining).

Not sure why the action is failling.

@adamltyson
Copy link
Member

The tool used to generate the custom 404 page doesn't work on sphinx 7.2.0:
readthedocs/sphinx-notfound-page#219

Pinned the sphinx version to 7.1.0 and raised #53 to track.

@willGraham01 willGraham01 merged commit 781920e into main Aug 24, 2023
2 checks passed
@willGraham01 willGraham01 deleted the add_new_release_instructions branch August 24, 2023 10:59
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.

2 participants