Skip to content

Commit

Permalink
doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
kwinkunks committed Feb 13, 2022
1 parent 72a6c88 commit 2f11fc0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 2f11fc0

Please sign in to comment.