remove pdf rtd build - sphinx tabs doesnt work on it

Author: bckohan

CONTRIBUTING.md

@@ -98,7 +98,6 @@ benchmark                # generate and document benchmarks
 build                    # build src package and wheel
 build-docs               # build the docs
 build-docs-html          # build html documentation
-build-docs-pdf           # build pdf documentation
 check                    # run all static checks
 check-docs               # lint the documentation
 check-docs-links         # check the documentation links for broken links

doc/.readthedocs.yaml

@@ -10,18 +10,7 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
-  apt_packages:
-    - libcairo2
-    - libpango-1.0-0
-    - libgdk-pixbuf2.0-0
-    - libffi-dev
-    - chromium-browser
-    - libasound2
   jobs:
-    post_create_environment:
-      - wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
-      - dpkg -x google-chrome-stable_current_amd64.deb $HOME/chrome
-      - touch $HOME/.rtd.build
     post_install:
       - pip install uv
       - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs --link-mode=copy
@@ -31,5 +20,6 @@ sphinx:
    configuration: doc/source/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
-formats:
-  - pdf
+# remove pdf for now - sphinx tabs does not support
+# formats:
+#   - pdf

doc/source/performance.rst

@@ -30,14 +30,9 @@ uninstall :pypi:`rich`. As of :pypi:`Typer` 0.17, :pypi:`rich` is lazily loaded,
 improvements <https://github.com/django-commons/django-typer/issues/170>`_ are made to :pypi:`Typer`
 , the import time penalty is still incurred by :pypi:`django-typer`.
 
-.. only:: html
+.. raw:: html
+    :file: _static/img/minimal_profile.svg
 
-   .. raw:: html
-      :file: _static/img/minimal_profile.svg
-
-.. only:: latex
-
-   .. literalinclude:: _static/img/minimal_profile.txt
 
 The second benchmark shows the same stats for the :ref:`polls example code <building_commands>`.
 These benchmarks compare the :class:`~django.core.management.BaseCommand` native implementation
@@ -46,11 +41,6 @@ using :pypi:`django-typer` is minimal. On the order of a few 10s of milliseconds
 :pypi:`rich` increases this overhead slightly, but the impact is still barely noticeable.
 
 
-.. only:: html
-
-   .. raw:: html
-      :file: _static/img/polls_profile.svg
-
-.. only:: latex
+.. raw:: html
+    :file: _static/img/polls_profile.svg
 
-   .. literalinclude:: _static/img/polls_profile.txt

justfile

@@ -105,17 +105,16 @@ clean: clean-docs clean-git-ignored clean-env
 build-docs-html: install-docs
     @just run sphinx-build --fresh-env --builder html --doctree-dir ./doc/build/doctrees ./doc/source ./doc/build/html
 
-[script]
-_open-pdf-docs:
-    import webbrowser
-    from pathlib import Path
-    webbrowser.open(f"file://{Path('./doc/build/pdf/django-typer.pdf').absolute()}")
-
-# build pdf documentation
-build-docs-pdf: install-docs
-    @just run sphinx-build --fresh-env --builder latex --doctree-dir ./doc/build/doctrees ./doc/source ./doc/build/pdf
-    make -C ./doc/build/pdf
-    @just _open-pdf-docs
+# [script]
+# _open-pdf-docs:
+#     import webbrowser
+#     from pathlib import Path
+#     webbrowser.open(f"file://{Path('./doc/build/pdf/django-typer.pdf').absolute()}")
+# # build pdf documentation
+# build-docs-pdf: install-docs
+#     @just run sphinx-build --fresh-env --builder latex --doctree-dir ./doc/build/doctrees ./doc/source ./doc/build/pdf
+#     make -C ./doc/build/pdf
+#     @just _open-pdf-docs
 
 # build the docs
 build-docs: build-docs-html

pyproject.toml

@@ -201,7 +201,6 @@ docs = [
     "sphinx-autobuild>=2024.10.3",
     "sphinx-tabs>=3.4.7",
     "sphinxcontrib-django>=2.5",
-    "sphinxcontrib-svg2pdfconverter[cairosvg]>=1.3.0",
     "sphinxcontrib-typer[png]>=0.5.1",
 ]
 profiling = [