Jupyter-book: Warning messages in book template (extra_navbar, extra_footer, test notebook)

[davewhipp]

Describe the bug
Defining extra_footer has no effect and there are several warning messages about extra_navbar, extra_footer, and a notebook file in the template book that is provided.

To Reproduce
Steps to reproduce the behavior:

1. Create a new jupyter book by typing jupyter-book create testbook
2. Build the book with jupyter-book build testbook
3. View the build output to see the warnings.

Expected behavior
I would expect not to see warning messages in the template, and also to be able to change the default footer by changing the configuration option for extra_footer.

See the output from building the template below.

$ jupyter-book clean testbook; jupyter-book build testbook
Running Sphinx v2.4.4
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 4 source files that are out of date
updating environment: [new config] 4 added, 4 changed, 0 removed
checking for /private/tmp/testbook/references.bib in bibtex cache... not found
parsing bibtex file /private/tmp/testbook/references.bib... parsed 5 entries
Executing: notebooks100%] notebooks

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... WARNING: unsupported theme option 'extra_navbar' given
WARNING: unsupported theme option 'extra_footer' given
done
writing output... [100%] notebooks
/private/tmp/testbook/notebooks.ipynb:10032: WARNING: unknown document: syntax
generating indices...  genindexdone
writing additional pages...  searchdone
copying images... [100%] _build/jupyter_execute/notebooks_2_0.png
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 3 warnings.

Environment (please complete the following information):

• Python Version 3.8.2
• Package Version 0.7.0b4

[MasterScrat]

I have the same problem with both extra_navbar and extra_footer.

I specify the following configuration in my _config.yml file:

...
html:
  extra_footer: "FOOBAR1"
  extra_navbar: "FOOBAR2"
...

But these custom strings don't appear in the generated output:

grep -r "FOOBAR" _build/
# no results!

Using Python 3.6.9, jupyter-book 0.7.0b3

[choldgraf]

Hmmm - so @MasterScrat first off could you upgrade to the latest beta? This was very recently added in.

@davewhipp could you try manually upgrading your sphinx book theme to see if this fixes things? (pip install -U sphinx-book-theme)

[davewhipp]

@choldgraf: That fixed it, thanks (I was running sphinx-book-theme 0.0.16)! Sorry for the trouble.

[choldgraf]

hmmm - can you try one more thing for me? Can you downgrade sphinx-book-theme back to the last version you were using, then instead upgrade jupyter book and see if that fixes it. I'm worried that it was possible to run the latest jupyter book, but somehow not the latest sphinx-book-theme

[davewhipp]

OK, so I did the following:

pip uninstall sphinx-book-theme
pip install sphinx-book-theme==0.0.16
pip install -U jupyter-book

I'm already running jupyter-book 0.7.0b4, so there was nothing to upgrade for jupyter-book itself. Perhaps the output that would be most useful is the following:

Requirement already up-to-date: jupyter-book in /Users/whipp/anaconda3/envs/jupyterbook/lib/python3.8/site-packages (0.7.0b4)
...
Requirement already satisfied, skipping upgrade: sphinx-book-theme in /Users/whipp/anaconda3/envs/jupyterbook/lib/python3.8/site-packages (from jupyter-book) (0.0.16)
...

Looks like the latest jupyter-book is OK with sphinx-book-theme 0.0.16 based on the snippet above.

[choldgraf]

ah ok, so I need to start pinning >= versions once we get a full release out, that is helpful thanks :-)

[choldgraf]

gonna close this one and open up https://github.com/executablebooks/jupyter-book/issues/675 to track

[MasterScrat]

Hmmm - so @MasterScrat first off could you upgrade to the latest beta? This was very recently added in.

Thank you for the quick answer, that fixed it.

I'm not sure why, but running pip install -U jupyter-book (which I had done before) didn't update to the latest beta, I had to run specifically pip install jupyter-book==0.7.0b4.

[choldgraf]

@MasterScrat ah that's probably because pip treats pre-releases different from other releases...hopefully it'll be fixed once we make an actual release