From 8ab2e18828dd609db99ecdf7138fc3b2e5b5233d Mon Sep 17 00:00:00 2001 From: Gagan Deep Date: Fri, 10 May 2024 23:01:30 +0530 Subject: [PATCH] [req-change] build_docs > build --- .github/workflows/ci.yml | 2 +- Makefile | 14 +++++++------- README.rst | 6 +++--- run-qa-checks | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a23c000..4ec3191 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -42,7 +42,7 @@ jobs: run: ./run-qa-checks - name: Build docs in all formats - run: PRODUCTION=1 make build_docs + run: PRODUCTION=1 make build # TODO: Uncomment the CI condition before merging - name: Setup Google Cloud diff --git a/Makefile b/Makefile index aed7dbc..9083cbc 100644 --- a/Makefile +++ b/Makefile @@ -17,8 +17,8 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help help: @echo "Please use \`make ' where is one of" - @echo " build_docs to build the documentation in all formats (PDF, HTML and ePUB)" - @echo " build_docs_html to build the documentation in HTML format only" + @echo " build to build the documentation in all formats (PDF, HTML and ePUB)" + @echo " build_html to build the documentation in HTML format only" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @@ -50,13 +50,13 @@ help: clean: rm -rf $(BUILDDIR)/* -.PHONY: build_docs -build_docs: +.PHONY: build +build: ./build.py $(formats) -.PHONY: build_docs_html -build_docs_html: - make build_docs formats=html +.PHONY: build_html +build_html: + make build formats=html .PHONY: html html: diff --git a/README.rst b/README.rst index 06e722e..2914a28 100644 --- a/README.rst +++ b/README.rst @@ -32,14 +32,14 @@ Requirements: Python >= 3.9. .. code-block:: shell # This command will generate the documentation in all formats - HTML, PDF and ePUB - make build_docs + make build # The ``formats`` argument is a comma separated list of formats to build, # e.g. ``formats=html,pdf,epub``. The default is to build all available # formats, which currently are ``html``, ``pdf`` and ``epub``. - make build_docs formats=pdf,html + make build formats=pdf,html # This command is a shortcut for generating only HTML documentation during # development, since building PDF and ePUB takes time. - make build_docs_html + make build_html 5. Open the generated HTML files in your browser. diff --git a/run-qa-checks b/run-qa-checks index b09253c..2a0f7ef 100755 --- a/run-qa-checks +++ b/run-qa-checks @@ -16,7 +16,7 @@ openwisp-qa-check \ echo '' echo 'Checking documentation build status' -make build_docs_html +make build_html # check for broken link python -m http.server 8001 &> /dev/null & pid=$!