diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..63f2b5e --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,46 @@ +name: Deploy documentation + +on: + push: + branches: + - main + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - uses: actions/setup-python@v4 + with: + python-version: "3.x" + cache: "pip" + cache-dependency-path: pyproject.toml + + - name: setup + run: | + make dev INSTALL_EXTRA=doc + + - name: build docs + run: | + make doc + + - name: upload docs artifact + uses: actions/upload-pages-artifact@v1.0.9 + with: + path: ./docs/_build/html/ + + deploy: + needs: build + runs-on: ubuntu-latest + permissions: + # NOTE: Needed to push to the repository. + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - id: deployment + uses: actions/deploy-pages@v2.0.2 diff --git a/README.md b/README.md index b06fbbc..81f4164 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # stdlib-list +[![PyPI version](https://badge.fury.io/py/stdlib-list.svg)](https://badge.fury.io/py/stdlib-list) +[![Downloads](https://static.pepy.tech/badge/stdlib-list)](https://pepy.tech/project/stdlib-list) +[![CI](https://github.com/pypi/stdlib-list/actions/workflows/ci.yml/badge.svg)](https://github.com/pypi/stdlib-list/actions/workflows/ci.yml) + This package includes lists of all of the standard libraries for Python 2.6 through 3.11. @@ -25,7 +29,7 @@ python -m pip install stdlib-list ['AL', 'BaseHTTPServer', 'Bastion', 'CGIHTTPServer', 'ColorPicker', 'ConfigParser', 'Cookie', 'DEVICE', 'DocXMLRPCServer', 'EasyDialogs'] ``` -For more details, check out [the docs](http://python-stdlib-list.readthedocs.org/en/latest/). +For more details, check out [the docs](https://pypi.github.io/stdlib-list/). ## Credits and Project History