Publish PDF version of RTD documentation

Made changes in the .readthedocs.yaml to enable format for downloading pdf and epub versions of the documentation and added latex_elements in the conf.py file which generates the pdf without blank pages. The minimum version requirement for sphinx was 6.2.1 which was causing build failure in read the docs, hence changing it 3.3.1 as written in setup.cfg of nexB/aboutcode Signed-off-by: Arijit De <[email protected]>
aboutcode-org · Jun 1, 2023 · e3aaf63 · e3aaf63
1 parent 8d205ef
commit e3aaf63
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/.readthedocs.yml b/.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

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -95,3 +95,9 @@
 .. role:: img-title-para
 
 """
+
+# -- Options for LaTeX output -------------------------------------------------
+
+latex_elements = {
+    'classoptions': ',openany,oneside'
+}
diff --git a/setup.cfg b/setup.cfg
@@ -58,6 +58,6 @@ testing =
     isort
 
 docs =
-    Sphinx == 6.2.1
+    Sphinx == 5.1.0
     sphinx-rtd-theme >= 0.5.0
     doc8 >= 0.8.1