Skip to content

Commit

Permalink
README for documentation helpers
Browse files Browse the repository at this point in the history
  • Loading branch information
berquist committed Mar 18, 2024
1 parent d197c8e commit 021c1c3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/sphinx/helpers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Documentation helpers for developers

This directory contains helpers for working with documentation.

## [milestone_issues_and_prs.py](milestone_issues_and_prs.py)

The Sphinx-based changelog consists of the reduction of issues and PRs to the repository between each version tag.
This script generates a Sphinx fragment containing the raw issue and PR titles, numbers, and authors that have been assigned to a GitHub milestone.
These should then be summarized and combined into more useful changelog entries.

In order to run the script (`python milestone_issues_and_prs.py > milestone_issues_and_prs.rst`),

- export the environment variable `GITHUB_API_TOKEN` to contain a Personal Access Token that has ~read privileges
- change the name of the milestone in [milestone_issues_and_prs.graphql](milestone_issues_and_prs.graphql) to match the upcoming release milestone

0 comments on commit 021c1c3

Please sign in to comment.