jupyter-book icon indicating copy to clipboard operation
jupyter-book copied to clipboard

Sphinx config `navigation with keys` removes links to Github

Open jorgensd opened this issue 2 years ago • 1 comments

Describe the bug

context When I add navigation_with_keys: True or False to

sphinx:
  config:
    html_theme_options:
      navigation_with_keys: true

in _config.yml, the repository buttons dissapear

expectation I expected Github repository buttons to appear if they are set to true.

bug But instead they disappear.

Reproduce the bug

  1. Install jupyterbook (I use venv with the following commands)
python3 -m venv --clear ./test_jb
source test_jb/bin/activate
python3 -m pip install jupyter-book
  1. Create book template
python3 -m jupyter book create test_book
  1. Test building
 python3 -m jupyter book build .

which gives image 4. add

sphinx:
  config:
    html_theme_options:
      navigation_with_keys: true

to config and rebuild. Returns image

List your environment

 python3 -m jupyter book --version
Jupyter Book      : 0.15.1
External ToC      : 0.3.1
MyST-Parser       : 0.18.1
MyST-NB           : 0.17.2
Sphinx Book Theme : 1.0.1
Jupyter-Cache     : 0.6.1
NbClient          : 0.7.4

Python 3.10.12 Ubuntu 22.04

jorgensd avatar Nov 15 '23 08:11 jorgensd

Any news regarding this?

jorgensd avatar Nov 21 '23 10:11 jorgensd