diff --git a/docs/development.md b/docs/development.md index 95cb44e..fc6feaa 100644 --- a/docs/development.md +++ b/docs/development.md @@ -26,7 +26,7 @@ Most of the tests are `doctest` tests, which are contained in the docstrings of ## Building the package -This repo uses PEP 517-style packaging. [Read more about this](https://setuptools.pypa.io/en/latest/build_meta.html) and [about Python packaging in general](https://packaging.python.org/en/latest/tutorials/packaging-projects/). +This repo uses PEP 518-style packaging. [Read more about this](https://setuptools.pypa.io/en/latest/build_meta.html) and [about Python packaging in general](https://packaging.python.org/en/latest/tutorials/packaging-projects/). Building the project requires `build`, so first: @@ -46,7 +46,7 @@ You can build the docs with the following commands: cd docs make html -Don't just run `sphinx-build manually: there is other stuff happening in the `Makefile`. +Don't just run `sphinx-build manually: there is other stuff happening in the `Makefile`. There is a continuous integration script to update the docs on published releases. diff --git a/docs/installation.md b/docs/installation.md index ef63e9a..e355ee7 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -2,18 +2,18 @@ At the command line: - $ pip install redflag + $ pip install gio Or, if you use Conda environments: - $ conda create -n redflag python=3.9 - $ conda activate redflag - $ pip install redflag + $ conda create -n gio python=3.9 + $ conda activate gio + $ pip install gio Installing `scikit-learn` allows you to access some extra options for outlier detection: - pip install redflag[sklearn] + pip install gio[sklearn] For developers, there are also options for installing `tests`, `docs` and `dev` dependencies. -If you want to help develop Redflag, please read [Development](development.md). +If you want to help develop `gio`, please read [Development](development.md).