diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index b40ad50..fac16a9 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -26,8 +26,6 @@ jobs: run: | cp README.md docs/index.md sed -i 's|docs/guide.md|guide/|g' docs/index.md - mkdir docs/media - cp media/logo.png docs/media/logo.png - name: Build mkdocs site run: mkdocs build diff --git a/README.md b/README.md index 87ab033..dcda6a8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# eppoPynder +# eppoPynder [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![codecov](https://codecov.io/gh/openefsa/eppoPynder/branch/main/graph/badge.svg?token=6U3TL9T27T)](https://codecov.io/gh/openefsa/eppoPynder) @@ -18,7 +18,7 @@ protection who require convenient programmatic access to EPPO data. ### From PyPi ``` -pip install eppopynder +pip install eppoPynder ``` ### Development version diff --git a/docs/guide.md b/docs/guide.md index d01fa18..1767ae3 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -111,7 +111,7 @@ help(function_name) This will show the full documentation for the function, including its arguments, return values, and usage examples. -For example, if you are working with the `uniform_taxonoy()` function, +For example, if you are working with the `uniform_taxonomy()` function, you can check its documentation with: ```python @@ -131,14 +131,14 @@ Note that the functions representing the categories are all defined inside the ## Querying a specific category The *eppoPynder* package allows you to query all categories available in -version 2.0 of the EPPO APIs: General, Taxons, Taxon, Country, Tools, Reporting -Services, and References. +version 2.0 of the EPPO APIs: General, Taxons, Taxon, Country, RPPO, Tools, +Reporting Service, and References. Each category has a corresponding function in the package with the same name -in *snake_case* format: general(), taxons(), taxon(), country(), tools(), -reporting_service(), and reportings(). By default, these functions return all -data available under the selected category, but you can customize the query by -specifying the desired services. +in *snake_case* format: general(), taxons(), taxon(), country(), rppo(), +tools(), reporting_service(), and references(). By default, these functions +return all data available under the selected category, but you can customize +the query by specifying the desired services. For example, to query all services of the Taxon category for the EPPO code "BEMITA", you can use the following code: diff --git a/pyproject.toml b/pyproject.toml index 1d6c405..0978a2c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,7 +34,7 @@ dev = [ ] [project.urls] -"Homepage" = "https://github.com/openefsa/eppoPynder" +"Homepage" = "https://openefsa.github.io/eppoPynder/" "Repository" = "https://github.com/openefsa/eppoPynder" "Bug Tracker" = "https://github.com/openefsa/eppoPynder/issues"