Use sphinx-nefertiti theme

chatnoir-eu · Nov 29, 2024 · 34bf7f0 · 34bf7f0
1 parent c019f0c
commit 34bf7f0
Show file tree

Hide file tree

Showing 5 changed files with 191 additions and 5 deletions.
diff --git a/docs/_static/chatnoir.svg b/docs/_static/chatnoir.svg
diff --git a/docs/_static/style.css b/docs/_static/style.css
@@ -51,3 +51,11 @@ h6 {
     padding-top: 24px;
     margin: 24px 0;
 }
+
+.project-logo {
+    background: white;
+    border: 0;
+    border-radius: 15%;
+    height: 36px;
+    width: 50px;
+}
diff --git a/docs/api/parse/html.rst b/docs/api/parse/html.rst
@@ -8,6 +8,7 @@ Resiliparse HTML parsing and DOM traversal utilities API documentation.
 .. automodule:: resiliparse.parse.html
    :members:
    :special-members: __iter__, __getitem__, __setitem__
+   :no-index:
 
    .. autoclass:: NodeType
       :members:

diff --git a/docs/conf.py b/docs/conf.py
@@ -37,7 +37,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx_click',
-    'sphinx_rtd_theme'
+    # 'sphinx_rtd_theme'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -56,13 +56,69 @@
 # 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 = 'sphinx_rtd_theme'
+# html_theme_options = {
+#     'collapse_navigation': False,
+#     'display_version': True,
+#     'style_external_links': True,
+# }
+
+html_theme = "sphinx_nefertiti"
 html_theme_options = {
-    'collapse_navigation': False,
-    'display_version': True,
-    'style_external_links': True,
+    "documentation_font": "Open Sans",
+    "documentation_font_size": "1.0rem",
+    "monospace_font": "Ubuntu Mono",
+    "monospace_font_size": "1.1rem",
+
+    "style": "red",
+    "pygments_light_style": "pastie",
+    "pygments_dark_style": "dracula",
+
+    "logo": "chatnoir.svg",
+    "logo_width": 50,
+    "logo_height": 36,
+    "logo_alt": "Nefertiti-for-Sphinx",
+
+    "repository_url": "https://github.com/chatnoir-eu/chatnoir-resiliparse",
+    "repository_name": "chatnoir-resiliparse",
+
+    "header_links": [
+        {
+            "text": "Chatnoir",
+            "link": "https://www.chatnoir.eu"
+        },
+        {
+            "text": "Resiliparse",
+            "dropdown": (
+                {
+                    "text": "Parsing Utilities",
+                    "link": "man/parse",
+                    "match": "/man/parse/*",
+                },
+                {
+                    "text": "Extraction Utilities",
+                    "link": "man/extract",
+                    "match": "/man/extract/*",
+                },
+                {
+                    "text": "Process Guards",
+                    "link": "man/process-guard",
+                },
+                {
+                    "text": "Itertools",
+                    "link": "man/itertools",
+                }
+            ),
+        },
+        {
+            "text": "FastWARC",
+            "link": "man/fastwarc",
+            "match": "/man/fastwarc/*"
+        }
+    ],
 }
 
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named 'default.css' will overwrite the builtin 'default.css'.

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,3 +3,4 @@ resiliparse[all]
 sphinx
 sphinx-click
 sphinx_rtd_theme
+sphinx-nefertiti