Fix documentation title formatting (#319)

* Docs: prevent title from overlapping content * Docs: cleanup warnings
jupyter · Feb 13, 2025 · 25a8c56 · 25a8c56
1 parent 4027fec
commit 25a8c56
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -14,7 +14,6 @@
 
 import sys
 import os
-import shlex
 import shutil
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -117,7 +116,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -198,10 +197,10 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+html_title = "Classic Jupyter Notebook"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+html_short_title = "NbClassic"
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,6 @@
-==================
+=================
 Jupyter NbClassic
-==================
+=================
 
 :ref:`Getting Started <NbClassicUsage>`
 

diff --git a/docs/source/security.rst b/docs/source/security.rst
@@ -1,3 +1,5 @@
+.. _server_security:
+
 Security in the Jupyter NbClassic server
 ========================================