Skip to content

Commit e80e61d

Browse files
authored
workflows: docs publishing (#85)
* workflows: docs publishing * docs: trigger * docs: cleanup * docs: undo testing * README: update docs URL * README: pretty badges
1 parent 5026214 commit e80e61d

File tree

2 files changed

+51
-1
lines changed

2 files changed

+51
-1
lines changed

.github/workflows/docs.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Deploy documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
15+
- uses: actions/setup-python@v4
16+
with:
17+
python-version: "3.x"
18+
cache: "pip"
19+
cache-dependency-path: pyproject.toml
20+
21+
- name: setup
22+
run: |
23+
make dev INSTALL_EXTRA=doc
24+
25+
- name: build docs
26+
run: |
27+
make doc
28+
29+
- name: upload docs artifact
30+
uses: actions/[email protected]
31+
with:
32+
path: ./docs/_build/html/
33+
34+
deploy:
35+
needs: build
36+
runs-on: ubuntu-latest
37+
permissions:
38+
# NOTE: Needed to push to the repository.
39+
pages: write
40+
id-token: write
41+
environment:
42+
name: github-pages
43+
url: ${{ steps.deployment.outputs.page_url }}
44+
steps:
45+
- id: deployment
46+
uses: actions/[email protected]

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# stdlib-list
22

3+
[![PyPI version](https://badge.fury.io/py/stdlib-list.svg)](https://badge.fury.io/py/stdlib-list)
4+
[![Downloads](https://static.pepy.tech/badge/stdlib-list)](https://pepy.tech/project/stdlib-list)
5+
[![CI](https://github.com/pypi/stdlib-list/actions/workflows/ci.yml/badge.svg)](https://github.com/pypi/stdlib-list/actions/workflows/ci.yml)
6+
37
This package includes lists of all of the standard libraries for Python 2.6
48
through 3.11.
59

@@ -25,7 +29,7 @@ python -m pip install stdlib-list
2529
['AL', 'BaseHTTPServer', 'Bastion', 'CGIHTTPServer', 'ColorPicker', 'ConfigParser', 'Cookie', 'DEVICE', 'DocXMLRPCServer', 'EasyDialogs']
2630
```
2731

28-
For more details, check out [the docs](http://python-stdlib-list.readthedocs.org/en/latest/).
32+
For more details, check out [the docs](https://pypi.github.io/stdlib-list/).
2933

3034
## Credits and Project History
3135

0 commit comments

Comments
 (0)