Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,17 @@ Happy coding!
* `jupyter-book build .` from root
* `python -m http.server --directory _build/html/`

### Spell check

* `pip install sphinxcontrib-spelling`
* `jupyter-book config sphinx` generates `conf.py`
* Add the following lines to `conf.py`:
```
spelling_ignore_pypi_package_names=True
spelling_word_list_filename = 'spelling_correctwords.txt'
```
* `sphinx-build -b spelling . ./_build` from root (this is in place of `jupyter-book build .`

## Deploy
[link](https://jupyterbook.org/start/publish.html#publish-your-book-online-with-github-pages)
1. Build book
Expand Down
5 changes: 5 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ html:
use_repository_button: true
favicon : "favicon.ico"

# Include sphinx extensions
sphinx:
extra_extensions:
- "sphinxcontrib.spelling"

# Surpress binder link since it doesn't work
launch_buttons:
binderhub_url: ""
10 changes: 10 additions & 0 deletions spelling_correctwords.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
dataframe
Dataframes
epsg
crs
legos
groupby
nan
NaN
Cawker
Filepaths