fix windows utf8 encoding 1/3 #719
Conversation
| @@ -0,0 +1,59 @@ | |||
| name: build-deploy-book | |||
There was a problem hiding this comment.
I'm a bit confused about the addition of this extra workflow - can you add a comment at the top describing what it is testing? Also rename to something more specific since build-deploy-book could apply to many of our other CI/CD jobs
There was a problem hiding this comment.
deleted -- that was vestigal -- I moved it into https://github.com/phaustin/jb_windows_test
and forgot to delete
| on: | ||
| push: | ||
| branches: | ||
| - utf8 |
| ls -lrtd * | ||
|
|
||
|
|
||
| # Push the book's HTML to github-pages |
There was a problem hiding this comment.
is there a reason we want a windows-specific docs deploy?
There was a problem hiding this comment.
for the record, the motivation behind the complicated workflow is to allow me to debug separate book problems by rendering independent html trees to the same gh-pages. The
environment takes about 4 minutes to set up for windows, so be able to do both the
encoding debugging and the unrelated nested/flat table of contents debugging (coming
next) in the same environment is a timesaver.
jupyter_book/__init__.py
Outdated
| @@ -5,7 +5,7 @@ | |||
| from .directive.toc import TableofContents | |||
|
|
|||
|
|
|||
| __version__ = "0.7.1dev0" | |||
| __version__ = "0.7.1dev2" | |||
There was a problem hiding this comment.
why is this being changed?
jupyter_book/commands/__init__.py
Outdated
| @@ -9,7 +9,7 @@ | |||
| import subprocess | |||
| from sphinx.util.osutil import cd | |||
|
|
|||
| from ..sphinx import build_sphinx | |||
| from ..jbsphinx import build_sphinx | |||
There was a problem hiding this comment.
why are you renaming this module?
There was a problem hiding this comment.
there's an issue with vscode running on windows -- the local sphinx module
shadows the global sphinx install so that importing sphinx.utils fails.
This was the path of least resistance around that problem, happy to revert if
necessary and just keep this on another fork.
There was a problem hiding this comment.
yeah I'd prefer not to rename the submodule if possible. You should be able to directly import anyway, ..sphinx should be treated differently from sphinx
There was a problem hiding this comment.
yes, it's definitely a problem with the vscode debugger -- there are a couple of vscode issues that I'll leave for someone who actually works with windows.
|
tests are passing and the changes LGTM, thanks for updating the PR and for the improvements @phaustin !! |
This is one of three pull requests that add
encoding = "utf8"to all read and write statementsfor jupyter-book and MyST-NB. To test, clone:
https://github.com/phaustin/jb_windows_test
Follow the instructions in:
https://github.com/phaustin/jb_windows_test/blob/master/Readme.md#test-for-utf8-encoding
to build the book with the environment.yml that specifies the three PRs.
The github action will display the finished section at:
https://phaustin.github.io/jb_windows_test/flat_test/about_py.html#testing-greek-characters