diff --git a/docs/source/_templates/sidebar-nav-bs-index.html b/docs/source/_templates/sidebar-nav-bs-index.html new file mode 100644 index 000000000..d43999f30 --- /dev/null +++ b/docs/source/_templates/sidebar-nav-bs-index.html @@ -0,0 +1,24 @@ + + + \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index e5031726d..684577736 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -161,12 +161,37 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = "pydata_sphinx_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + "icon_links": [ + { + "name": "PyPI", + "url": "https://pypi.org/project/nbclassic", + "icon": "fa-solid fa-box", + } + ], + "use_edit_page_button": True, + "github_url": "https://github.com/jupyter/nbclassic", + "navbar_end": [ + # disabled until widget dark variables are available + # "theme-switcher", + "navbar-icon-links", + ], + "secondary_sidebar_items": ["edit-this-page", "sourcelink", "search-field.html"] +} + +html_context = { + # disabled until widget dark variables are available + "default_mode": "light", + "doc_path": "docs", + "github_repo": "nbclassic", + "github_user": "jupyter", + "github_version": "main", +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -209,7 +234,9 @@ #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +html_sidebars = { + "**": ["sidebar-nav-bs-index.html"] +} # Additional templates that should be rendered to pages, maps page names to # template names. diff --git a/docs/source/frontend_config.rst b/docs/source/frontend_config.rst index b0430ad42..b750e6487 100644 --- a/docs/source/frontend_config.rst +++ b/docs/source/frontend_config.rst @@ -1,7 +1,7 @@ .. _frontend_config: Configuring the NbClassic frontend -================================= +================================== .. note:: diff --git a/docs/source/nbclassic.rst b/docs/source/nbclassic.rst index da26c250f..bff852753 100644 --- a/docs/source/nbclassic.rst +++ b/docs/source/nbclassic.rst @@ -1,8 +1,12 @@ +:html_theme.sidebar_secondary.remove: + .. _htmlnotebook: Jupyter NbClassic ==================== - +.. toctree:: + :maxdepth: 2 + Introduction ------------ @@ -34,14 +38,14 @@ Installation ~~~~~~~~~~~~ Installing from PyPI: -``> pip install nbclassic`` +``pip install nbclassic`` This will automatically enable the extension in Jupyter Server. Launch directly: -``> jupyter nbclassic`` +``jupyter nbclassic`` Alternatively, you can run Jupyter Server and visit the `/tree` endpoint: -``> jupyter server`` +``jupyter server`` Configuration ~~~~~~~~~~~~~ diff --git a/nbclassic/static/base/js/namespace.js b/nbclassic/static/base/js/namespace.js index c570dd4fc..9f3deb03d 100644 --- a/nbclassic/static/base/js/namespace.js +++ b/nbclassic/static/base/js/namespace.js @@ -73,7 +73,7 @@ define(function(){ // tree jglobal('SessionList','tree/js/sessionlist'); - Jupyter.version = "1.0.0"; + Jupyter.version = "1.1.0.dev0"; Jupyter._target = '_blank'; return Jupyter;