Merge pull request #159 from joalla/docs_theme

New theme for our documentation
joalla · Oct 23, 2024 · b73595d · b73595d
2 parents a39c757 + 44dce6d
commit b73595d
Show file tree

Hide file tree

Showing 11 changed files with 74 additions and 43 deletions.
diff --git a/docs/source/_static/p3dc.css b/docs/source/_static/p3dc.css
@@ -0,0 +1,11 @@
+html {
+    --pst-font-size-base: 14px;
+    --pst-header-height: 5rem;
+}
+
+@media (prefers-reduced-motion) {
+    .bd-sidebar-primary, .bd-sidebar-secondary {
+        transition-duration: 0s;
+    }
+}
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -50,24 +50,34 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
-
-# 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".
-html_static_path = ['_static']
-
-html_theme_options = {
-    'collapse_navigation': False,
-    'navigation_depth': 8,
-    'sticky_navigation': True,
-    'prev_next_buttons_location': 'bottom'
-}
+html_theme = "pydata_sphinx_theme"
 
 html_last_updated_fmt = "%b %d, %Y"
-
 html_logo = '_static/discogs-vinyl-record-mark-50x50.png'
+html_context = {
+    "github_user": "joalla",
+    "github_repo": "discogs_client",
+    "github_version": "master",
+    "doc_path": "docs/source/",
+}
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/joalla/discogs_client",
+            "icon": "fa-brands fa-github",
+        },
+    ],
+    "use_edit_page_button": True,
+    "header_links_before_dropdown": 3,
+    "show_toc_level": 5,
+    "back_to_top_button": True,
+}
+html_title = ""
+html_static_path = ["_static"]
+html_css_files = ["p3dc.css"]
 
+# MyST extenstion configuration
 myst_heading_anchors = 7
 myst_enable_extensions = [
     "substitution"

diff --git a/docs/source/discogs_client.client.rst b/docs/source/discogs_client.client.rst
@@ -0,0 +1,4 @@
+discogs\_client.client module
+=============================
+
+.. automodule:: discogs_client.client
diff --git a/docs/source/discogs_client.exceptions.rst b/docs/source/discogs_client.exceptions.rst
@@ -0,0 +1,5 @@
+discogs\_client.exceptions module
+=================================
+
+.. automodule:: discogs_client.exceptions
+
diff --git a/docs/source/discogs_client.fetchers.rst b/docs/source/discogs_client.fetchers.rst
@@ -0,0 +1,5 @@
+discogs\_client.fetchers module
+===============================
+
+.. automodule:: discogs_client.fetchers
+
diff --git a/docs/source/discogs_client.models.rst b/docs/source/discogs_client.models.rst
@@ -0,0 +1,5 @@
+discogs\_client.models module
+=============================
+
+.. automodule:: discogs_client.models
+
diff --git a/docs/source/discogs_client.rst b/docs/source/discogs_client.rst
diff --git a/docs/source/discogs_client.utils.rst b/docs/source/discogs_client.utils.rst
@@ -0,0 +1,5 @@
+discogs\_client.utils module
+============================
+
+.. automodule:: discogs_client.utils
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,7 +19,7 @@ python3-discogs-client documentation
    optional_configuration.md
    contributing.md
    writing_docs.md
-   discogs_client
+   index_discogs_client
 
 
 Indices and tables

diff --git a/docs/source/index_discogs_client.rst b/docs/source/index_discogs_client.rst
@@ -0,0 +1,13 @@
+discogs_client package
+======================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   discogs_client.client
+   discogs_client.exceptions
+   discogs_client.fetchers
+   discogs_client.models
+   discogs_client.utils
+
diff --git a/setup.py b/setup.py
@@ -32,7 +32,7 @@
        extras_require={
            "docs": [
                "sphinx",
-               "sphinx-rtd-theme",
+               "pydata-sphinx-theme",
                "myst-parser",
            ],
        }