Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,7 @@ source/developer/localization.md
*.doctree
_build/
build/

# weasyprint PDFs
venv/
__pycache__/
13 changes: 13 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,16 @@ else
@mkdir -p "$(BUILDDIR)"
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS2) $(O) -w "$(WARNINGSFILE)"
endif

.PHONY: pdf cleanpdf

pdf:
@echo "Building HTML docs using pipenv..."
@pipenv run sphinx-build -M clean source build
@pipenv run sphinx-build -M html source build
@echo "Generating clean PDF guides using venv..."
@venv/bin/python generate_pdfs.py

cleanpdf:
@echo "Cleaning up generated PDFs..."
@rm -rf pdfs
32 changes: 1 addition & 31 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,16 @@ verify_ssl = true
name = "pypi"

[dev-packages]
#
# Amazon AWS Universal CLI environment (https://aws.amazon.com/cli/)
# Release notes: https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst
# Repo: https://github.com/aws/aws-cli
awscli = "==1.40.7"
#
# PyTest testing framework (https://docs.pytest.org/en/7.4.x/)
pytest = "==8.3.5"
#
# exceptiongroup: Backport of PEP-654 Exception groups to Python <3.11
exceptiongroup = {version = "*", markers = "python_version < '3.11'"}
#
# Black: A Python source formatter
black = "==25.1.0"
#
# Docutils Stubs
docutils-stubs = "==0.0.22"

[packages]
#
# Sphinx (https://www.sphinx-doc.org)
# Release notes: https://www.sphinx-doc.org/en/master/changes.html
# Repo: https://github.com/sphinx-doc/sphinx
sphinx = "==8.2.3"
#
# Furo Theme (https://github.com/pradyunsg/furo)
furo = "==2024.8.6"
#
# MyST Parser (https://myst-parser.readthedocs.io/en/latest/)
# Release notes: https://myst-parser.readthedocs.io/en/latest/develop/_changelog.html
# Repo: https://github.com/executablebooks/myst-parser
myst-parser = "==4.0.1"
#
# Sphinx Autobuild (https://github.com/executablebooks/sphinx-autobuild)
# Repo: https://github.com/executablebooks/sphinx-autobuild
sphinx-autobuild = "==2024.10.3"
#
# Add a "copy" button to code blocks in Sphinx (https://sphinx-copybutton.readthedocs.io/en/latest/)
# Repo: https://github.com/executablebooks/sphinx-copybutton
sphinx-copybutton = "==0.5.2"
#
# MermaidJS support for Sphinx
sphinxcontrib-mermaid = "==1.0.0"
sphinx = "8.2.3"
28 changes: 14 additions & 14 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading