Overhaul PDF Generation

.github/workflows/booklets.yaml

@@ -0,0 +1,47 @@
+name: "Booklets Builder"
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build-booklets:
+    runs-on: ubuntu-latest
+    if: github.repository == 'uvidyadharan/ftcdocs'
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout Repository  
+        uses: actions/checkout@v3
+
+      - name: Refresh Packages
+        run: sudo apt-fast -y update
+
+      - name: Install Dependencies
+        run: xargs -a dependencies sudo apt-fast install -y
+
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+          cache: 'pip'
+
+      - name: Python Install Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build Booklets
+        env:
+          SPHINXOPTS: "-D html_context.commit=${{ github.sha }} -D version=latest -A display_github=true -A github_user=${{ github.repository_owner }} -A github_repo=${{ github.event.repository.name }} -A github_version=${{ github.ref_name }} -A conf_py_path=/docs/source/"
+        run: make -C docs/ booklets
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          role-to-assume: arn:aws:iam::549273919012:role/gh-actions/ftc-docs-uploader
+          aws-region: us-west-2
+      - name: Upload Booklets to S3
+        run: |
+          aws s3 sync docs/build/booklets s3://ftc-docs-cdn/booklets/en --delete

.github/workflows/pull-request.yaml

@@ -76,7 +76,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository  
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - uses: reviewdog/action-misspell@v1
         with:
@@ -123,5 +123,8 @@ jobs:
         with:
           python-version: 3.8
 
+      - name: Python Install Dependencies
+        run: pip install -r docs/requirements.txt
+
       - name: image-check
-        run: make -C docs/ imagecheck
+        run: make -C docs/ imagecheck

dependencies

@@ -1,3 +1,4 @@
 texlive-xetex
 latexmk
 jq
+fonts-roboto

docs/Makefile

@@ -15,6 +15,8 @@ SIZEMAX       = 500
 AUTOBUILD = sphinx-autobuild
 HTMLBUILDDIR = build/html
 LATEXBUILDDIR = build/latex/
+BOOKLETSBUILDDIR = build/booklets
+
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -24,6 +26,15 @@ help:
 autobuild:
 	@$(AUTOBUILD) $(SOURCEDIR) $(HTMLBUILDDIR) --port=7350
 
+--move-booklets:
+	mkdir -p $(BOOKLETSBUILDDIR)
+	cp $(addsuffix .pdf, $(basename $(wildcard $(LATEXBUILDDIR)*.tex))) $(BOOKLETSBUILDDIR)
+
+--generate-booklets:
+	BOOKLETS_BUILD="true" $(SPHINXBUILD) -M latexpdf $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) $(O)
+
+booklets: --generate-booklets --move-booklets
+
 local-full:
 	DOCS_BUILD="true" $(SPHINXBUILD) -b html $(SOURCEDIR) $(HTMLBUILDDIR) $(SPHINXOPTS) $(O)
 	@$(SPHINXBUILD) -M latexpdf $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) $(O)

docs/requirements.txt

@@ -6,4 +6,6 @@ git+https://github.com/FIRST-Tech-Challenge/ftcdocs-helper@main#subdirectory=jav
 sphinx_design==0.2.0
 git+https://github.com/FIRST-Tech-Challenge/ftcdocs-helper@main#subdirectory=googleanalytics
 git+https://github.com/FIRST-Tech-Challenge/ftcdocs-helper@main#subdirectory=cookiebanner
-sphinx-sitemap==2.3.0
+sphinx-sitemap==2.3.0
+python-git-info==0.8.3
+sphinxcontrib-mermaid==0.9.2

docs/source/booklets/advanced.rst

@@ -0,0 +1,30 @@
+:orphan:
+
+.. only:: latex
+
+    Advanced Topics, Progrmming Resources
+    =====================================
+
+    .. toctree::
+        :maxdepth: 1
+        :titlesonly:
+
+        /programming_resources/vision/vision_overview/vision-overview
+        /programming_resources/vision/tensorflow_pp_2022/tensorflow_pp_2022
+        /programming_resources/vision/blocks_tfod_opmode/blocks-tfod-opmode
+        /programming_resources/vision/java_tfod_opmode/java-tfod-opmode
+        /programming_resources/vision/tensorflow_ff_2021/tensorflow-ff-2021
+        /programming_resources/vision/webcam_controls/webcam-controls
+        Camera Calibration </programming_resources/vision/camera_calibration/camera-calibration>
+
+    .. toctree::
+        :maxdepth: 1
+        :titlesonly:
+
+        /programming_resources/shared/pid_coefficients/pid-coefficients
+        /programming_resources/shared/pidf_coefficients/pidf-coefficients
+        /programming_resources/shared/auto_load_opmode/auto-load-opmode
+        /programming_resources/shared/myblocks/index
+        /programming_resources/shared/external_libraries_blocks/external-libraries-blocks.rst
+        /programming_resources/imu/imu.rst
+        /programming_resources/shared/installing_kotlin/Installing-Kotlin

docs/source/booklets/apriltags.rst

@@ -0,0 +1,15 @@
+:orphan:
+
+.. only:: latex
+
+    April Tags in *FIRST* Tech Challenge
+    ====================================
+
+    .. toctree::
+
+        AprilTag Introduction </apriltag/vision_portal/apriltag_intro/apriltag-intro>
+        VisionPortal Overview </apriltag/vision_portal/visionportal_overview/visionportal-overview>
+        Understanding AprilTag Values </apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values>
+        AprilTag Test Images </apriltag/opmode_test_images/opmode-test-images>
+
+

docs/source/booklets/control_system.rst

@@ -0,0 +1,13 @@
+:orphan:
+
+.. only:: latex
+
+    *FIRST* Tech Challenge Control System
+    =====================================
+
+    .. toctree::
+
+       /programming_resources/shared/control_system_intro/The-FTC-Control-System 
+       /control_hard_compon/index
+       /hardware_and_software_configuration/index
+

docs/source/booklets/index.rst

@@ -0,0 +1,29 @@
+Booklets
+========
+
+More 'bite-sized' versions of the FTC Docs. These are meant to be printed out and used as a reference for teams.
+
+.. 
+    In order to add a booklet, add a link to the booklet in the list below. The link should be in the format of:
+    https://ftc-docs-cdn.ftclive.org/booklets/en/<booklet_name>.pdf
+
+FTC Machine Learning
+--------------------
+- `FTC ML Manual <https://ftc-docs-cdn.ftclive.org/booklets/en/ftc_ml.pdf>`_
+
+Programming Resources
+---------------------
+- `Programming Resources <https://ftc-docs-cdn.ftclive.org/booklets/en/prgrm_res.pdf>`_
+- `Android Studios Manual <https://ftc-docs-cdn.ftclive.org/booklets/en/android_studios.pdf>`_
+- `OnBot Java Manual <https://ftc-docs-cdn.ftclive.org/booklets/en/onbot_java.pdf>`_
+- `Blocks Manual <https://ftc-docs-cdn.ftclive.org/booklets/en/blocks.pdf>`_
+
+- `April Tags <https://ftc-docs-cdn.ftclive.org/booklets/en/april_tags.pdf>`_
+- `Advanced User <https://ftc-docs-cdn.ftclive.org/booklets/en/advanced.pdf>`_
+- `FTC SDK Guide <https://ftc-docs-cdn.ftclive.org/booklets/en/sdk.pdf>`_
+
+Control System
+--------------
+
+- `Control System <https://ftc-docs-cdn.ftclive.org/booklets/en/control_system.pdf>`_
+

docs/source/booklets/sdk.rst

@@ -0,0 +1,14 @@
+:orphan:
+
+.. only:: latex
+
+    *FIRST* Tech Challenge SDK
+    ==========================
+
+    .. toctree::
+
+        SDK Overview </ftc_sdk/overview/index>
+        Updating Components </ftc_sdk/updating/index>
+
+
+