WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Build docs PR preview on RTD #115

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

Open
stevepiercy wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Build docs PR preview on RTD #115

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
97b5089
Poke the PR to see if it builds now.
stevepiercy Dec 3, 2025
0db199d
Overhaul Makefile
stevepiercy Dec 4, 2025
9ada725
Clean up .gitignore
stevepiercy Dec 4, 2025
e9d4ea0
Don't ignore uv.lock
stevepiercy Dec 4, 2025
ec19647
Purge comments from conf.py and update to find package information
stevepiercy Dec 4, 2025
d86dd26
Remove unused import
stevepiercy Dec 4, 2025
efb47a6
Update uv.lock
stevepiercy Dec 4, 2025
b518d5c
Convert README.md from reST to MD.
stevepiercy Dec 4, 2025
1a96d9a
Fix to assume commands in path when inside nix shell
datakurre Dec 4, 2025
945f81b
Fix to disable uv sync when in nix shell
datakurre Dec 4, 2025
b928930
- Refactor plone-javascript to plone-client
stevepiercy Dec 7, 2025
5f0e680
A wee bit more docs
stevepiercy Dec 7, 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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.cache
.coverage
.devenv*
.pre-commit-config.yaml
.eggs/
_build/
coverage.xml
Expand Down
13 changes: 9 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,17 @@ SPHINXOPTS ?=
PAPER ?=

# Internal variables.
SPHINXBUILD = "$(realpath .venv/bin/sphinx-build)"
SPHINXAUTOBUILD = "$(realpath .venv/bin/sphinx-autobuild)"
DOCS_DIR = ./docs/
BUILDDIR = ../_build
ifdef IN_NIX_SHELL
BIN_FOLDER = $(shell dirname "$$(command -v python)")
VENV_FOLDER = $(shell dirname "$(BIN_FOLDER)")
else
VENV_FOLDER = ./.venv
BIN_FOLDER = $(VENV_FOLDER)/bin
endif
DOCS_DIR = ./docs/
BUILDDIR = ../_build
SPHINXBUILD = "$(realpath $(BIN_FOLDER)/sphinx-build)"
SPHINXAUTOBUILD = "$(realpath $(BIN_FOLDER)/sphinx-autobuild)"
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
Expand Down