diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index fac16a9..3d47365 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -25,7 +25,6 @@ jobs: - name: Generate index.md from README.md run: | cp README.md docs/index.md - sed -i 's|docs/guide.md|guide/|g' docs/index.md - name: Build mkdocs site run: mkdocs build diff --git a/README.md b/README.md index 895b36b..bb26135 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ require convenient programmatic access to DistillerSR data. ## Installation -### From PyPi +### From PyPI ``` pip install pystiller @@ -41,7 +41,7 @@ from pystiller import * ``` Basic usage examples and full documentation are available in the package -[guide](docs/guide.md). +[guide](https://openefsa.github.io/pystiller/guide/). ## Authors and maintainers @@ -53,6 +53,6 @@ Basic usage examples and full documentation are available in the package ## Links -- **Homepage**: [GitHub](https://github.com/openefsa/pystiller). -- **Bug Tracker**: [Issues on GitHub](https://github.com/openefsa/pystiller/issues). +- **Source code**: [GitHub - openefsa/pystiller](https://github.com/openefsa/pystiller). +- **Bug tracker**: [Issues on GitHub](https://github.com/openefsa/pystiller/issues). - **DistillerSR API Documentation**: [https://apidocs.evidencepartners.com/](https://apidocs.evidencepartners.com/). diff --git a/docs/guide.md b/docs/guide.md index e0523bb..23bb37f 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -11,7 +11,7 @@ require convenient programmatic access to DistillerSR data. ## Installation -### From PyPi +### From PyPI ``` pip install pystiller