Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix docs pdf build #196

Merged
merged 3 commits into from
Mar 12, 2025
Merged

fix docs pdf build #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0698a6c
fix docs pdf build
bckohan Mar 12, 2025
3285b4f
Merge branch 'main' into uv
bckohan Mar 12, 2025
a470cd3
fix latepdf doc build
bckohan Mar 12, 2025
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
18 changes: 0 additions & 18 deletions doc/broken_links.py
View file
Open in desktop

This file was deleted.

10 changes: 9 additions & 1 deletion justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,17 @@ 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 latexpdf --doctree-dir ./doc/build/doctrees ./doc/source ./doc/build/pdf
@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
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ rich = ["rich>=10.11.0,<14.0.0"]
"Documentation" = "https://django-typer.readthedocs.io"
"Repository" = "https://github.com/django-commons/django-typer"
"Issues" = "https://github.com/django-commons/django-typer/issues"
"Changelog" = "https://django-typer.readthedocs.io/en/latest/changelog.html"
"Changelog" = "https://django-typer.readthedocs.io/en/stable/changelog.html"
"Code_of_Conduct" = "https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md"


Expand Down Expand Up @@ -197,7 +197,7 @@ docs = [
"sphinx>=7.4.7",
"sphinx-autobuild>=2024.10.3",
"sphinx-tabs>=3.4.7",
"sphinxcontrib-typer>=0.5.1",
"sphinxcontrib-typer[png]>=0.5.1",
]
psycopg3 = [
"psycopg>=3.1.8",
Expand Down
Loading
Loading