Skip to content

Commit

Permalink
Update documentation for GitHub Pages
Browse files Browse the repository at this point in the history
- Handle new poetry dev-convention in dependencies-table.py
  • Loading branch information
arneso-ssb committed Aug 21, 2023
1 parent eabcbb1 commit dd287a5
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
14 changes: 14 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,23 @@ $ nox -s pre-commit -- install
2. Go to the Account Settings on PyPI, select Publishing,
and set up a new pending publisher as described on
[Creating a PyPI Project with a Trusted Publisher][trusted publisher].
3. Use the following information for the new pending publisher:
- PyPI Project name: Name of the GitHub repo.
- Owner: GitHub organization name or GitHub username that owns the repository.
- Repository name: Name of the GitHub repo.
- Workflow name: `release.yml`

### TestPyPI

1. Sign up at [TestPyPI].
2. Go to the Account Settings on TestPyPI, select Publishing,
and set up a new pending publisher as described on
[Creating a PyPI Project with a Trusted Publisher][trusted publisher].
3. Use the following information for the new pending publisher:
- PyPI Project name: Name of the GitHub repo.
- Owner: GitHub organization name or GitHub username that owns the repository.
- Repository name: Name of the GitHub repo.
- Workflow name: `release.yml`

### Codecov

Expand All @@ -114,6 +124,10 @@ $ nox -s pre-commit -- install

### GitHub Pages

1. Log in to [GitHub].
2. Select Settings, Pages and set Source to "GitHub Actions" below the
Build and Deployment heading.

[GitHub Pages] should work out of the box. The pages are deployed to<br>
`<github username>.github.io/<repo name>` or <br>
`<github organization>.github.io/<repo name>`.
Expand Down
4 changes: 2 additions & 2 deletions tools/dependencies-table.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ def main() -> None:

dependencies = {
canonicalize_name(dependency)
for section in ["dependencies", "dev-dependencies"]
for dependency in data["tool"]["poetry"][section].keys()
for section in ["dependencies"] # TODO Handle both dev and normal dependencies
for dependency in data["tool"]["poetry"]["group"]["dev"][section].keys()
if dependency != "python"
}

Expand Down

0 comments on commit dd287a5

Please sign in to comment.