From 5ab9b3a15e0095a8186ca3870cb9f9eade83833d Mon Sep 17 00:00:00 2001
From: Omkar Phansopkar <omkarphansopkar@gmail.com>
Date: Wed, 18 Oct 2023 15:42:56 +0530
Subject: [PATCH] Added docs server script, dark mode & copybutton for docs

Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com>
---
 .github/workflows/docs-ci.yml    |  3 ---
 docs/Makefile                    |  8 ++++++++
 docs/make.bat                    | 12 ++++++++++++
 docs/scripts/doc8_style_check.sh |  0
 docs/source/conf.py              |  4 ++++
 setup.cfg                        |  3 +++
 6 files changed, 27 insertions(+), 3 deletions(-)
 mode change 100644 => 100755 docs/scripts/doc8_style_check.sh

diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml
index 511b7c283a..ada779bfcb 100644
--- a/.github/workflows/docs-ci.yml
+++ b/.github/workflows/docs-ci.yml
@@ -20,9 +20,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Give permission to run scripts
-        run: chmod +x ./docs/scripts/doc8_style_check.sh
-
       - name: Install Dependencies
         run:  pip install -e .[docs]
 
diff --git a/docs/Makefile b/docs/Makefile
index d0c3cbf102..788b039619 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -5,6 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -14,6 +15,13 @@ help:
 
 .PHONY: help Makefile
 
+# Run the development server using sphinx-autobuild
+docs:
+	@echo
+	@echo "Starting up the docs server..."
+	@echo
+	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
diff --git a/docs/make.bat b/docs/make.bat
index 6247f7e231..4a3c1a4852 100644
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -7,11 +7,16 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
+if "%SPHINXAUTOBUILD%" == "" (
+	set SPHINXAUTOBUILD=sphinx-autobuild
+)
 set SOURCEDIR=source
 set BUILDDIR=build
 
 if "%1" == "" goto help
 
+if "%1" == "docs" goto docs
+
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -28,6 +33,13 @@ if errorlevel 9009 (
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
+:docs
+@echo
+@echo Starting up the docs server...
+@echo
+%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+goto end
+
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
diff --git a/docs/scripts/doc8_style_check.sh b/docs/scripts/doc8_style_check.sh
old mode 100644
new mode 100755
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 918d62c115..54e5e665a3 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -30,6 +30,10 @@
 extensions = [
     "sphinx.ext.intersphinx",
     "sphinx_reredirects",
+    'sphinx_rtd_theme',
+    "sphinx_rtd_dark_mode",
+    "sphinx.ext.extlinks",
+    "sphinx_copybutton",
 ]
 
 
diff --git a/setup.cfg b/setup.cfg
index d6c7da7d1e..bd0e58a705 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -62,4 +62,7 @@ docs =
     sphinx-rtd-theme>=1.0.0
     sphinx-reredirects >= 0.1.2
     doc8>=0.11.2
+    sphinx-autobuild
+    sphinx-rtd-dark-mode>=1.3.0
+    sphinx-copybutton