Skip to content

Commit

Permalink
Stop autogenerating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thatbudakguy committed Sep 1, 2023
1 parent 951afb8 commit 4f6a14d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 34 deletions.
31 changes: 0 additions & 31 deletions .github/workflows/docs.yml

This file was deleted.

5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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
```
Expand Down

0 comments on commit 4f6a14d

Please sign in to comment.