From 99a4219e31f2aab52d97d33523773bb8aa56a799 Mon Sep 17 00:00:00 2001 From: Koji Tanaka Date: Mon, 18 Mar 2024 00:20:04 +0900 Subject: [PATCH 1/4] build: Set permissions for GitHub actions (Same change as #7387) --- .github/workflows/ci.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cb6cb234e8..ae02461ed9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,6 +8,9 @@ on: branches: - '*' +permissions: + contents: read + jobs: build: runs-on: ubuntu-latest From 9cf54c080cbe64ecc619fdabd36f7e25d0a4f46e Mon Sep 17 00:00:00 2001 From: Koji Tanaka Date: Mon, 18 Mar 2024 00:21:15 +0900 Subject: [PATCH 2/4] build: Bump GitHub Actions (Same changes as #7704) --- .github/workflows/ci.yml | 4 +++- .github/workflows/deploy_2x.yml | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ae02461ed9..f2ac7ae0b9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,7 +20,9 @@ jobs: doc-type: ['HTML', 'EPUB', 'PDF'] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 with: fetch-depth: 1 diff --git a/.github/workflows/deploy_2x.yml b/.github/workflows/deploy_2x.yml index 48ce15fe8e..716cc4e6c0 100644 --- a/.github/workflows/deploy_2x.yml +++ b/.github/workflows/deploy_2x.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Cloning repo - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: fetch-depth: 0 From 0f56a7d8d0dd1ab396924382480e249b38ed1491 Mon Sep 17 00:00:00 2001 From: Koji Tanaka Date: Mon, 18 Mar 2024 00:30:32 +0900 Subject: [PATCH 3/4] build: Upgrade to Sphinx 7 (Same changes as #7641) --- .github/workflows/ci.yml | 8 +------- Dockerfile | 18 ++++++++++++------ Makefile | 18 ++++++++++-------- en/Makefile | 25 ++++++++++++------------- es/Makefile | 25 ++++++++++++------------- fr/Makefile | 25 ++++++++++++------------- ja/Makefile | 25 ++++++++++++------------- pt/Makefile | 25 ++++++++++++------------- requirements.txt | 8 ++++---- zh/Makefile | 25 ++++++++++++------------- 10 files changed, 99 insertions(+), 103 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f2ac7ae0b9..1944f0086c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -16,7 +16,6 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: [3.9] doc-type: ['HTML', 'EPUB', 'PDF'] steps: @@ -24,12 +23,7 @@ jobs: - uses: actions/setup-python@v5 with: - fetch-depth: 1 - - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 - with: - python-version: ${{ matrix.python-version }} + python-version: 3.11 - name: Install dependencies run: | diff --git a/Dockerfile b/Dockerfile index bbba480fc7..a3c82aa89d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,22 +1,28 @@ -FROM debian:bullseye +FROM debian:bookworm ENV DEBIAN_FRONTEND noninteractive LABEL Description="This image is used to create an environment to contribute to the cakephp/docs" RUN apt-get update && apt-get install -y \ - python3-pip \ - texlive-latex-recommended \ - texlive-latex-extra \ + build-essential \ + latexmk \ + php \ + python3-full \ texlive-fonts-recommended \ texlive-lang-all \ - latexmk \ + texlive-latex-extra \ + texlive-latex-recommended \ && apt-get clean \ && rm -rf /var/lib/apt/lists/* +RUN python3 -m venv /tmp/venv +ENV PATH="/tmp/venv/bin:$PATH" + COPY requirements.txt /tmp/ -RUN pip3 install -r /tmp/requirements.txt +RUN pip install -r /tmp/requirements.txt WORKDIR /data +VOLUME "/data" CMD ["/bin/bash"] diff --git a/Makefile b/Makefile index c5348437ab..baab82b24f 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ # Inspired by the Makefile used by bazaar. # https://bazaar.launchpad.net/~bzr-pqm/bzr/2.3/ -PYTHON = python +PYTHON = python3 ES_HOST = ES_HOST_V2 = @@ -16,6 +16,9 @@ PDF_LANGS = en es fr pt DEST = website +EPUB_ARGS = +SPHINXOPTS = + # Get path to theme directory to build static assets. THEME_DIR = $(shell python3 -c 'import os, cakephpsphinx; print(os.path.abspath(os.path.dirname(cakephpsphinx.__file__)))') @@ -30,13 +33,13 @@ epub: $(foreach lang, $(LANGS), epub-$(lang)) latex: $(foreach lang, $(PDF_LANGS), latex-$(lang)) pdf: $(foreach lang, $(PDF_LANGS), pdf-$(lang)) htmlhelp: $(foreach lang, $(LANGS), htmlhelp-$(lang)) -populate-index: $(foreach lang, $(LANGS), populate-index-$(lang)) +server: $(foreach lang, $(LANGS), server-$(lang)) rebuild-index: $(foreach lang, $(LANGS), rebuild-index-$(lang)) # Make the HTML version of the documentation with correctly nested language folders. html-%: - cd $* && make html + cd $* && make html SPHINXOPTS="$(SPHINXOPTS)" make build/html/$*/_static/css/dist.css make build/html/$*/_static/js/dist.js @@ -52,12 +55,11 @@ latex-%: pdf-%: cd $* && make latexpdf -populate-index-%: - php scripts/populate_search_index.php --lang="$*" --host="$(ES_HOST_V2)" +server-%: + cd build/html/$* && python3 -m SimpleHTTPServer -rebuild-index-%: - curl -XDELETE $(ES_HOST)/documentation/2-2-$* - php scripts/populate_search_index.php $* $(ES_HOST) +epub-check-%: build/epub/$* + java -jar /epubcheck/epubcheck.jar build/epub/$*/CakePHP.epub $(EPUB_ARGS) website-dirs: # Make the directory if its not there already. diff --git a/en/Makefile b/en/Makefile index c602689913..e29f5ac5c5 100644 --- a/en/Makefile +++ b/en/Makefile @@ -7,13 +7,12 @@ PAPER = BUILDDIR = ../build CONFDIR = ../config PYTHON = python3 -LANG = en SPHINX_LANG = en # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(SPHINX_LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest @@ -40,9 +39,9 @@ clean: -rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(LANG) + $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(SPHINX_LANG) @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(LANG)." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(SPHINX_LANG)." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @@ -65,10 +64,10 @@ json: @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(LANG) + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(SPHINX_LANG) @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp/$(LANG)." + ".hhp project file in $(BUILDDIR)/htmlhelp/$(SPHINX_LANG)." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @@ -89,22 +88,22 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(LANG) + $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(SPHINX_LANG) @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(LANG)." + @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(SPHINX_LANG)." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(LANG)." + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex/$(LANG) all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(LANG)." + make -C $(BUILDDIR)/latex/$(SPHINX_LANG) all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text diff --git a/es/Makefile b/es/Makefile index d1954803a6..ad4fde2697 100644 --- a/es/Makefile +++ b/es/Makefile @@ -8,13 +8,12 @@ PAPER = BUILDDIR = ../build CONFDIR = ../config PYTHON = python3 -LANG = es SPHINX_LANG = es # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(SPHINX_LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest @@ -41,9 +40,9 @@ clean: -rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(LANG) + $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(SPHINX_LANG) @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(LANG)." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(SPHINX_LANG)." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @@ -66,10 +65,10 @@ json: @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(LANG) + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(SPHINX_LANG) @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp/$(LANG)." + ".hhp project file in $(BUILDDIR)/htmlhelp/$(SPHINX_LANG)." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @@ -90,22 +89,22 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(LANG) + $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(SPHINX_LANG) @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(LANG)." + @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(SPHINX_LANG)." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(LANG)." + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex/$(LANG) all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(LANG)." + make -C $(BUILDDIR)/latex/$(SPHINX_LANG) all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text diff --git a/fr/Makefile b/fr/Makefile index 1827e4417a..ae8709114b 100644 --- a/fr/Makefile +++ b/fr/Makefile @@ -8,13 +8,12 @@ PAPER = BUILDDIR = ../build CONFDIR = ../config PYTHON = python3 -LANG = fr SPHINX_LANG = fr # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(SPHINX_LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest @@ -41,9 +40,9 @@ clean: -rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(LANG) + $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(SPHINX_LANG) @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(LANG)." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(SPHINX_LANG)." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @@ -66,10 +65,10 @@ json: @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(LANG) + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(SPHINX_LANG) @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp/$(LANG)." + ".hhp project file in $(BUILDDIR)/htmlhelp/$(SPHINX_LANG)." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @@ -90,22 +89,22 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(LANG) + $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(SPHINX_LANG) @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(LANG)." + @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(SPHINX_LANG)." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(LANG)." + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex/$(LANG) all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(LANG)." + make -C $(BUILDDIR)/latex/$(SPHINX_LANG) all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text diff --git a/ja/Makefile b/ja/Makefile index 7ae750a365..6eaaa019c3 100644 --- a/ja/Makefile +++ b/ja/Makefile @@ -8,13 +8,12 @@ PAPER = BUILDDIR = ../build CONFDIR = ../config PYTHON = python3 -LANG = ja SPHINX_LANG = ja # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(SPHINX_LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest @@ -41,9 +40,9 @@ clean: -rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(LANG) + $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(SPHINX_LANG) @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(LANG)." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(SPHINX_LANG)." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @@ -66,10 +65,10 @@ json: @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(LANG) + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(SPHINX_LANG) @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp/$(LANG)." + ".hhp project file in $(BUILDDIR)/htmlhelp/$(SPHINX_LANG)." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @@ -90,22 +89,22 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(LANG) + $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(SPHINX_LANG) @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(LANG)." + @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(SPHINX_LANG)." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(LANG)." + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex/$(LANG) all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(LANG)." + make -C $(BUILDDIR)/latex/$(SPHINX_LANG) all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text diff --git a/pt/Makefile b/pt/Makefile index 9f3182401a..4492ba7d46 100644 --- a/pt/Makefile +++ b/pt/Makefile @@ -8,13 +8,12 @@ PAPER = BUILDDIR = ../build CONFDIR = ../config PYTHON = python3 -LANG = pt SPHINX_LANG = pt_BR # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(SPHINX_LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest @@ -41,9 +40,9 @@ clean: -rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(LANG) + $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(SPHINX_LANG) @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(LANG)." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(SPHINX_LANG)." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @@ -66,10 +65,10 @@ json: @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(LANG) + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(SPHINX_LANG) @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp/$(LANG)." + ".hhp project file in $(BUILDDIR)/htmlhelp/$(SPHINX_LANG)." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @@ -90,22 +89,22 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(LANG) + $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(SPHINX_LANG) @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(LANG)." + @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(SPHINX_LANG)." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(LANG)." + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex/$(LANG) all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(LANG)." + make -C $(BUILDDIR)/latex/$(SPHINX_LANG) all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text diff --git a/requirements.txt b/requirements.txt index bb3532e048..5793b68834 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -docutils==0.17.1 -sphinx==4.5.0 -sphinxcontrib-phpdomain==0.8.0 -cakephpsphinx>=0.1.55,<1.0 +docutils==0.20.1 +sphinx==7.0.1 +sphinxcontrib-phpdomain==0.11.1 +cakephpsphinx>=0.1.57,<1.0 diff --git a/zh/Makefile b/zh/Makefile index c659542910..5f6031338e 100644 --- a/zh/Makefile +++ b/zh/Makefile @@ -8,13 +8,12 @@ PAPER = BUILDDIR = ../build CONFDIR = ../config PYTHON = python3 -LANG = zh SPHINX_LANG = zh_CN # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees/$(SPHINX_LANG) -c $(CONFDIR) -D language=$(SPHINX_LANG) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest @@ -41,9 +40,9 @@ clean: -rm -rf $(BUILDDIR)/* html: - $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(LANG) + $(SPHINXBUILD) -b html -D "exclude_patterns=*-contents.rst" $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(SPHINX_LANG) @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(LANG)." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(SPHINX_LANG)." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @@ -66,10 +65,10 @@ json: @echo "Build finished; now you can process the JSON files." htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(LANG) + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(SPHINX_LANG) @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp/$(LANG)." + ".hhp project file in $(BUILDDIR)/htmlhelp/$(SPHINX_LANG)." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @@ -90,22 +89,22 @@ devhelp: @echo "# devhelp" epub: - $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(LANG) + $(SPHINXBUILD) -b epub -D master_doc='epub-contents' $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(SPHINX_LANG) @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(LANG)." + @echo "Build finished. The epub file is in $(BUILDDIR)/epub/$(SPHINX_LANG)." latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(LANG)." + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(LANG) + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(SPHINX_LANG) @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex/$(LANG) all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(LANG)." + make -C $(BUILDDIR)/latex/$(SPHINX_LANG) all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(SPHINX_LANG)." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text From a8dd75a4055e9cdf0c8d499addd05e189d1e8b2d Mon Sep 17 00:00:00 2001 From: Koji Tanaka Date: Mon, 18 Mar 2024 00:30:43 +0900 Subject: [PATCH 4/4] build: Update apt packages first --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1944f0086c..41b8e54de3 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -32,6 +32,7 @@ jobs: - name: Install packages run: | + sudo apt update sudo apt install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-lang-all - name: Build Docs