Skip to content
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.

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

build: add nltk dependency to run docs examples #168

Merged
merged 4 commits into from
Jun 9, 2021

Conversation

oboulant
Copy link
Collaborator

@oboulant oboulant commented Jun 8, 2021

@github-actions github-actions bot added the Type: Maintenance Repository Maintenance label Jun 8, 2021
@codecov
Copy link

codecov bot commented Jun 8, 2021

Codecov Report

Merging #168 (38bc02b) into master (dd3dc67) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #168   +/-   ##
=======================================
  Coverage   96.02%   96.02%           
=======================================
  Files          40       40           
  Lines         980      980           
=======================================
  Hits          941      941           
  Misses         39       39           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dd3dc67...38bc02b. Read the comment docs.

@oboulant oboulant changed the title chore:add nltk dependency to run docs examples chore: add nltk dependency to run docs examples Jun 8, 2021
@oboulant oboulant requested a review from deepcharles June 8, 2021 14:00
@oboulant
Copy link
Collaborator Author

oboulant commented Jun 8, 2021

@deepcharles I had to add the dependency to livereload. Not a big fan since according to me it should be mkdocs duty to handle this as a dependency. But not mentionning it as a dependencies fails the > mkdocs build command.

@deepcharles
Copy link
Owner

This issue is due to a new version of mkdocs where livereload is not listed as a dependency any more although it is used by mkdocstrings (mkdocs/mkdocs#2448).
People at mkdocsstrings are currently working on the problem (mkdocstrings/mkdocstrings#295). In the meantime I would rather pin the version of mkdocs to the latest working version (i.e. 1.1.2) instead of adding a dependency to livereload in ruptures.

@deepcharles deepcharles changed the title chore: add nltk dependency to run docs examples build: add nltk dependency to run docs examples Jun 9, 2021
@oboulant oboulant merged commit 8733cb1 into master Jun 9, 2021
@oboulant oboulant deleted the docs-nltk-dependency branch June 9, 2021 07:19
deepcharles added a commit that referenced this pull request Jun 9, 2021
* Update labeler.yml

* build: add nltk dependency to run docs examples (#168)

* chore:add nltk dependency to run docs examples

* chore: add livereload dependency. Not sure if this is an error on mkdocs side

* build: remove livereload dependency

* build: pin mkdocs version

Co-authored-by: Charles T <charles@doffy.net>

* feat(display): more display options (#160)

* more_display_options

- Add the ability for the user to pass arguments to format the computed_chg_pts
  axvline parameters.

Modified:
src/ruptures/show/display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - review changes

- Changes to docstrings, etc as per review request.

Modified:
src/ruptures/show/display.py

* more_display_options - review changes

- Changes to docstrings, etc as per review request.

Modified:
src/ruptures/show/display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - test

- Added tests.

Modified:
tests/test_display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - do not redeclare variables

- Just use the arguments for color, linewidth and linestyle, tests should pass.

Modified:
src/ruptures/show/display.py

* more_display_options - do not redeclare variables

- Typo

Modified:
src/ruptures/show/display.py

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update labeler.yml

Co-authored-by: Olivier Boulant <olivier.boulant@hey.com>
Co-authored-by: earthgecko <96679+earthgecko@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
deepcharles added a commit that referenced this pull request Jun 9, 2021
* chore: pre-commit autoupdate

updates:
- [github.com/nbQA-dev/nbQA: 0.10.0 → 0.11.1](nbQA-dev/nbQA@0.10.0...0.11.1)

* build: add nltk dependency to run docs examples (#168)

* chore:add nltk dependency to run docs examples

* chore: add livereload dependency. Not sure if this is an error on mkdocs side

* build: remove livereload dependency

* build: pin mkdocs version

Co-authored-by: Charles T <charles@doffy.net>

* feat(display): more display options (#160)

* more_display_options

- Add the ability for the user to pass arguments to format the computed_chg_pts
  axvline parameters.

Modified:
src/ruptures/show/display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - review changes

- Changes to docstrings, etc as per review request.

Modified:
src/ruptures/show/display.py

* more_display_options - review changes

- Changes to docstrings, etc as per review request.

Modified:
src/ruptures/show/display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - test

- Added tests.

Modified:
tests/test_display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - do not redeclare variables

- Just use the arguments for color, linewidth and linestyle, tests should pass.

Modified:
src/ruptures/show/display.py

* more_display_options - do not redeclare variables

- Typo

Modified:
src/ruptures/show/display.py

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* chore: better PR labeler (#169)

* Update labeler.yml

* build: add nltk dependency to run docs examples (#168)

* chore:add nltk dependency to run docs examples

* chore: add livereload dependency. Not sure if this is an error on mkdocs side

* build: remove livereload dependency

* build: pin mkdocs version

Co-authored-by: Charles T <charles@doffy.net>

* feat(display): more display options (#160)

* more_display_options

- Add the ability for the user to pass arguments to format the computed_chg_pts
  axvline parameters.

Modified:
src/ruptures/show/display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - review changes

- Changes to docstrings, etc as per review request.

Modified:
src/ruptures/show/display.py

* more_display_options - review changes

- Changes to docstrings, etc as per review request.

Modified:
src/ruptures/show/display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - test

- Added tests.

Modified:
tests/test_display.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more_display_options - do not redeclare variables

- Just use the arguments for color, linewidth and linestyle, tests should pass.

Modified:
src/ruptures/show/display.py

* more_display_options - do not redeclare variables

- Typo

Modified:
src/ruptures/show/display.py

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update labeler.yml

Co-authored-by: Olivier Boulant <olivier.boulant@hey.com>
Co-authored-by: earthgecko <96679+earthgecko@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* chore: pre-commit autoupdate

updates:
- [github.com/nbQA-dev/nbQA: 0.10.0 → 0.11.1](nbQA-dev/nbQA@0.10.0...0.11.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Olivier Boulant <olivier.boulant@hey.com>
Co-authored-by: Charles T <charles@doffy.net>
Co-authored-by: earthgecko <96679+earthgecko@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Maintenance Repository Maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants