add bin/ entrypoint for building PDF

To export the docs as a PDF
ByteInternet · Jan 14, 2024 · 2793a4e · 2793a4e
1 parent f0ea468
commit 2793a4e
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ pub
 *.css.map
 deployment-report.json
 build/
+venv/
diff --git a/README.md b/README.md
@@ -115,3 +115,12 @@ To inspect the contents of the deb archive you can run:
 /usr/share/doc/hndocsnext/README.md
 /usr/share/doc/hndocsnext/changelog.gz
 ```
+
+## Build as PDF
+
+To build the documentation as a single PDF file, run the following command:
+```
+bin/build_pdf
+```
+
+The built PDF will then be in `docs/_build/pdf/`.
diff --git a/bin/build_pdf b/bin/build_pdf
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+pushd docs
+make pdf
+echo "pdf located at $(realpath _build/pdf/Python.pdf)"
+popd
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,8 +21,9 @@
 # -- Project information -----------------------------------------------------
 
 project = "Docs"
-copyright = "2023, Hypernode"
+copyright = "2024, Hypernode"
 author = "Hypernode"
+version = "https://docs.hypernode.com/"
 
 # The full version, including alpha/beta/rc tags
 release = "dev"
@@ -47,6 +48,7 @@
     "hypernode.sphinx.extensions.meta_robots",
     "hypernode.sphinx.extensions.github_actions_logging",
     "sphinxcontrib.mermaid",
+    "rst2pdf.pdfbuilder",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/requirements/base.txt b/requirements/base.txt
@@ -11,6 +11,7 @@ sphinx-notfound-page==0.8.3
 sphinx-sitemap==2.4.0
 GitPython==3.1.30
 sphinxcontrib-mermaid==0.7.1
+rst2pdf==0.99
 
 # hypernode/ requirements
 beautifulsoup4==4.11.1
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,3 +9,4 @@ pub @@
     *.css.map
     deployment-report.json
     build/
+    venv/