Merge remote-tracking branch 'skeleton/main' into clean-docs

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

.github/workflows/docs-ci.yml

@@ -13,10 +13,10 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 

.github/workflows/pypi-release.yml

@@ -24,9 +24,9 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
           python-version: 3.9
 

.readthedocs.yml

@@ -5,6 +5,11 @@
 # Required
 version: 2
 
+# Build PDF & ePub
+formats:
+  - epub
+  - pdf
+
 # Where the Sphinx conf.py file is located
 sphinx:
    configuration: docs/source/conf.py

docs/source/conf.py

@@ -95,3 +95,9 @@
 .. role:: img-title-para
 
 """
+
+# -- Options for LaTeX output -------------------------------------------------
+
+latex_elements = {
+    'classoptions': ',openany,oneside'
+}

setup.cfg

@@ -72,7 +72,7 @@ testing =
     black
     mock
 
-docs=
-    Sphinx==6.2.1
-    sphinx-rtd-theme>=0.5.0
-    doc8>=0.8.1
+docs =
+    Sphinx == 5.1.0
+    sphinx-rtd-theme >= 0.5.0
+    doc8 >= 0.8.1