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.

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

Upgrade jupyter-book to version 1.0 #14

Merged
merged 5 commits into from
Feb 5, 2024
Merged

Upgrade jupyter-book to version 1.0 #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7e177e7
MAINT: Upgrade jupyter-book to version 1.0
ghisvail Feb 5, 2024
346d0b9
DOC: Fix download of French corpus
ghisvail Feb 5, 2024
857f596
MAINT: Do not refresh config when building or serving the docs
ghisvail Feb 5, 2024
f6a05c0
STY: Add missing white space in displacy call
ghisvail Feb 5, 2024
eee2a8f
CI: Fix generated Sphinx config by Jupyter Book
ghisvail Feb 5, 2024
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
1 change: 1 addition & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ build:
- pip install -e ".[docs,metrics-ner,nlstruct,srt-io-converter,webrtc-voice-detector]"
pre_build:
- jupyter-book config sphinx docs/
- sed "s/'sphinx_book_theme',//" docs/conf.py # See https://github.com/executablebooks/jupyter-book/pull/2111
6 changes: 3 additions & 3 deletions docs/examples/spacy/spacy_io.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ For this example, you should download the french spacy model. You can download i
```{code-cell} ipython3
:tags: [remove-output]

!python -m spacy download fr_core_news_sm
import spacy.cli
spacy.cli.download("fr_core_news_sm")
```

Consider the following spacy document:
Expand Down Expand Up @@ -73,8 +74,7 @@ displacy.render(spacy_doc, style="ent")
---

```{code-cell} ipython3
displacy.render(spacy_doc, style="span",options={"spans_key": "SECTION"})

displacy.render(spacy_doc, style="span", options={"spans_key": "SECTION"})
```

The spacy document has **2** entities and **1** span group called `SECTION`.
Expand Down
12 changes: 3 additions & 9 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ all = [
webrtc-voice-detector]""",
]
docs = [
"jupyter-book==0.15.*",
"jupyter-book==1.0.*,",
"matplotlib",
"pandas>=1.4",
"spacy>=3.4",
Expand Down Expand Up @@ -214,14 +214,8 @@ python = "3.10"

[tool.hatch.envs.docs.scripts]
config = "jupyter-book config sphinx docs/"
build = [
"config",
"sphinx-build docs/ {args:docs/_build/html}",
]
serve = [
"config",
"sphinx-autobuild docs/ {args:docs/_build/html}",
]
build = "sphinx-build docs/ {args:docs/_build/html}"
serve = "sphinx-autobuild docs/ {args:docs/_build/html}"

[tool.coverage.run]
source_pkgs = ["medkit", "tests"]
Expand Down
Loading