diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml index 72c26ab304..40f800f49a 100644 --- a/.github/workflows/pages.yaml +++ b/.github/workflows/pages.yaml @@ -1,13 +1,11 @@ name: Release docs on: - workflow_dispatch: push: branches: - - master - - 'branch-**' - paths: - - 'docs/**' + - master + tags: + - '**' jobs: release: diff --git a/docs/Makefile b/docs/Makefile index 9a0a8c7e3b..5c820c402e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -45,7 +45,7 @@ singlehtml: setup @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." .PHONY: epub -epub: setup +epub: setup $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." @@ -66,11 +66,13 @@ dummy: setup linkcheck: setup $(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck -GIT_BRANCH = $(shell git branch --show-current) - .PHONY: multiversion multiversion: setup @mkdir -p $(HOME)/.cache/pypoetry/virtualenvs - $(POETRY) run sphinx-multiversion -D smv_branch_whitelist=$(GIT_BRANCH) -D smv_outputdir_format=$(GIT_BRANCH:branch-%=%) $(SOURCEDIR) $(BUILDDIR)/dirhtml + $(POETRY) run sphinx-multiversion $(SOURCEDIR) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: multiversionpreview +multiversionpreview: multiversion + $(POETRY) run python3 -m http.server 5500 --directory $(BUILDDIR)/dirhtml \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 9a6ea37fae..745fb5b951 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -5,6 +5,7 @@ from sphinx.util import logging import recommonmark from recommonmark.transform import AutoStructify +from sphinx_scylladb_theme.utils import multiversion_regex_builder logger = logging.getLogger(__name__) @@ -151,9 +152,11 @@ def setup(sphinx): # -- Options for multiversion extension ---------------------------------- # Whitelist pattern for tags (set to None to ignore all tags) -smv_tag_whitelist = r'^.*$' +TAGS = [] +smv_tag_whitelist = multiversion_regex_builder(TAGS) # Whitelist pattern for branches (set to None to ignore all branches) -smv_branch_whitelist = r"^master$" +BRANCHES = ['master'] +smv_branch_whitelist = multiversion_regex_builder(BRANCHES) # Whitelist pattern for remotes (set to None to use local branches only) smv_remote_whitelist = r"^origin$" # Pattern for released versions