This is an automated email from the ASF dual-hosted git repository.
zrhoffman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 982e67955c Documentation-based changelog generation (#7254)
982e67955c is described below
commit 982e67955c1097192a09ef8ac13fc1f851085ca9
Author: ocket8888 <[email protected]>
AuthorDate: Fri Apr 21 11:38:44 2023 -0600
Documentation-based changelog generation (#7254)
* Add a way to generate API-specific changelogs
* Allow overriding version for the entire changelog generation
---
docs/Makefile | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/docs/Makefile b/docs/Makefile
index 7d43cdb3f2..be542bb558 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -18,6 +18,8 @@
# under the License.
#
+VERSION ?= $(file < ../VERSION)
+
# You can set these variables from the command line.
SPHINXOPTS = -j auto
SPHINXBUILD = python3 -m sphinx
@@ -29,7 +31,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees
$(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-.PHONY: all help clean html dirhtml singlehtml pickle json htmlhelp qthelp
devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: all help clean html dirhtml singlehtml pickle json htmlhelp qthelp
devhelp epub latex latexpdf text man changes linkcheck doctest gettext
apichanges
T3C_SOURCE_DIRS := $(patsubst %/,%,$(dir $(wildcard
../cache-config/**/README.md)))
T3C_RST_SRC := $(join $(T3C_SOURCE_DIRS),
$(T3C_SOURCE_DIRS:../cache-config/%=/%.rst))
@@ -177,10 +179,13 @@ gettext: $(BUILDDIR) $(T3C_RST_OUT)
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes: $(BUILDDIR) $(T3C_RST_OUT)
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ $(SPHINXBUILD) -b changes -D version=$(VERSION) $(ALLSPHINXOPTS)
$(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
+apichanges: $(BUILDDIR)
+ $(SPHINXBUILD) -b changes -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER))
$(SPHINXOPTS) -c source/ -D version=$(VERSION) source/api/
$(BUILDDIR)/apichanges
+
linkcheck: $(BUILDDIR) $(T3C_RST_OUT)
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
