Skip to content

Add update checker installation to docs #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gsheni merged 4 commits into from
Jun 18, 2021
Merged

Add update checker installation to docs #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59116a3
add to install page
jeff-hernandez Jun 17, 2021
c35a570
update release notes
jeff-hernandez Jun 17, 2021
ae052f9
use quotes
jeff-hernandez Jun 17, 2021
b05a70d
add header
jeff-hernandez Jun 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ conda install -c conda-forge composeml
**Update checker** - Receive automatic notifications of new Compose releases

```
python -m pip install composeml[update_checker]
python -m pip install "composeml[update_checker]"
```

## Example
Expand Down
12 changes: 12 additions & 0 deletions docs/source/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ To install from PyPI_, run this command:

pip install composeml

Add-ons
-------

Update checker
~~~~~~~~~~~~~~

Receive automatic notifications of new Compose releases

.. code-block::

python -m pip install "composeml[update_checker]"

conda
=====

Expand Down
2 changes: 1 addition & 1 deletion docs/source/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Release Notes
**Future Release**
* Enhancements
* Add ``maximum_data`` parameter to control when a search should stop (:pr:`216`)
* Add optional automatic update checker (:pr:`223`, :pr:`229`)
* Add optional automatic update checker (:pr:`223`, :pr:`229`, :pr:`232`)
* Fixes
* Documentation Changes
* Update doc tutorials to the latest API changes (:pr:`227`)
Expand Down