[req-change] build_docs > build

.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

Makefile

@@ -17,8 +17,8 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 .PHONY: help
 help:
 	@echo "Please use \`make <target>' where <target> 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:

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.
 

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=$!