diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 32623f9..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: docs - -on: - push: - branches: - - main - -jobs: - docs: - name: generate docs with pdoc3 - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-python@v2 - with: - python-version: 3.8 - - uses: actions/cache@v2 - with: - path: ~/.cache/pip - key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- - - run: pip install -r requirements.txt - - run: pip install pdoc3 - - run: python setup.py develop - - run: pdoc --html dphon - - run: rm -rf docs/* && mv html/dphon/* docs/ - - uses: EndBug/add-and-commit@v5 - with: - add: "docs/ --force" - message: "Update documentation" diff --git a/README.md b/README.md index 8daae9c..50ee331 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # dphon [![ci](https://github.com/direct-phonology/dphon/workflows/ci/badge.svg)](https://github.com/direct-phonology/dphon/actions?query=workflow%3Aci) -[![docs](https://github.com/direct-phonology/dphon/workflows/docs/badge.svg)](https://direct-phonology.github.io/dphon) [![codecov](https://codecov.io/gh/direct-phonology/dphon/branch/main/graph/badge.svg?token=uGbgB5UFtk)](https://codecov.io/gh/direct-phonology/dphon) [![pypi](https://img.shields.io/pypi/v/dphon.svg?style=flat)](https://pypi.org/project/dphon/) ![pyversions](https://img.shields.io/pypi/pyversions/dphon.svg?style=flat) @@ -138,9 +137,9 @@ now your changes will be automatically picked up when you run `dphon`. pull requests can be made against `main`. ## code documentation -code documentation is [available on github pages](https://direct-phonology.github.io/dphon) and is automatically generated with `pdoc3` on pushes to `main`. +code documentation is [available on github pages](https://direct-phonology.github.io/dphon) and is generated with `pdoc3`. -to build documentation locally: +to build the docs: ```sh $ pdoc --html --output-dir docs dphon ```