Merge pull request #180 from praw-dev/dark_mode

Add dark mode to docs
praw-dev · Jun 12, 2022 · d6f9dfd · d6f9dfd
2 parents dc7bbfd + f463da3
commit d6f9dfd
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 14 deletions.
diff --git a/docs/_static/CodeUrl.png b/docs/_static/CodeUrl.png
diff --git a/docs/_static/CreateApp.png b/docs/_static/CreateApp.png
diff --git a/docs/_static/theme_override.css b/docs/_static/theme_override.css
@@ -4,15 +4,21 @@ https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html */
 /* override table width restrictions */
 @media screen and (min-width: 767px) {
 
-   .wy-table-responsive table td {
-      /* !important prevents the common CSS stylesheets from overriding
-         this as on RTD they are loaded after this stylesheet */
-      white-space: normal !important;
-   }
+    .wy-table-responsive table td {
+        /* !important prevents the common CSS stylesheets from overriding
+           this as on RTD they are loaded after this stylesheet */
+        white-space: normal !important;
+    }
 
-   .wy-table-responsive {
-      overflow: visible !important;
-   }
+    .wy-table-responsive {
+        overflow: visible !important;
+    }
 }
 
-table.center-table-items, table.center-table-items th { text-align: center; }
+table.center-table-items, table.center-table-items th {
+    text-align: center;
+}
+
+html[data-theme='dark'] .btn-neutral {
+color: #c1c1c1 !important;
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -11,16 +11,17 @@
 copyright = datetime.today().strftime("%Y, Joel Payne")
 exclude_patterns = ["_build"]
 extensions = [
-    "sphinx_rtd_theme",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
+    "sphinx_rtd_dark_mode",
+    "sphinx_rtd_theme",
     "sphinxcontrib_trio",
 ]
 html_static_path = ["_static"]
 html_theme = "sphinx_rtd_theme"
 html_theme_options = {"collapse_navigation": True}
 htmlhelp_basename = "Async PRAW"
-intersphinx_mapping = {"python": ("https://docs.python.org", None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 master_doc = "index"
 nitpick_ignore = [
     ("py:class", "IO"),

diff --git a/setup.py b/setup.py
@@ -16,13 +16,13 @@
 extras = {
     "ci": ["coveralls"],
     "dev": ["packaging"],
-    "lint": [
-        "pre-commit",
+    "lint": ["pre-commit"],
+    "readthedocs": [
         "sphinx",
+        "sphinx-rtd-dark-mode",
         "sphinx_rtd_theme",
         "sphinxcontrib-trio",
     ],
-    "readthedocs": ["sphinx", "sphinx_rtd_theme", "sphinxcontrib-trio"],
     "test": [
         "asynctest >=0.13.0",
         "mock >=0.8",
@@ -35,6 +35,7 @@
         else "vcrpy@git+https://github.com/kevin1024/vcrpy.git@b1bc5c3a02db0447c28ab9a4cee314aeb6cdf1a7",
     ],
 }
+extras["lint"] += extras["readthedocs"]
 extras["dev"] += extras["lint"] + extras["test"]
 
 setup(