Merge pull request #14 from roundcube/renovate-setup

Renovate setup

.github/workflows/build_and_publish.yml

@@ -16,12 +16,12 @@ jobs:
       - uses: actions/checkout@v4
       - name: Build static files
         id: build
-        run: make
+        run: ./bin/install-deps-in-sphinx-container.sh && make pages
       - name: Upload static files as artifact
         id: deployment
         uses: actions/upload-pages-artifact@v3
         with:
-          path: _build/html/
+          path: pages
 
   # Deployment job
   deploy:

.gitignore

@@ -0,0 +1,3 @@
+source/locale/
+pages/
+build/

.tx/config

@@ -1,110 +1,151 @@
 [main]
 host = https://www.transifex.com
 lang_map = sk_SK: sk, de_DE: de
-type = PO
-
-[roundcube-webmail-help.index]
-file_filter = locale/<lang>/LC_MESSAGES/index.po
-source_file = _build/locale/index.pot
-source_lang = en
-
-[roundcube-webmail-help.login]
-file_filter = locale/<lang>/LC_MESSAGES/login.po
-source_file = _build/locale/login.pot
-source_lang = en
-
-[roundcube-webmail-help.overview]
-file_filter = locale/<lang>/LC_MESSAGES/overview.po
-source_file = _build/locale/overview.pot
-source_lang = en
-
-[roundcube-webmail-help.sphinx]
-file_filter = locale/<lang>/LC_MESSAGES/sphinx.po
-source_file = _build/locale/sphinx.pot
-source_lang = en
-
-[roundcube-webmail-help.addressbook--addressbookview]
-file_filter = locale/<lang>/LC_MESSAGES/addressbook/addressbookview.po
-source_file = _build/locale/addressbook/addressbookview.pot
-source_lang = en
-
-[roundcube-webmail-help.addressbook--editing]
-file_filter = locale/<lang>/LC_MESSAGES/addressbook/editing.po
-source_file = _build/locale/addressbook/editing.pot
-source_lang = en
-
-[roundcube-webmail-help.addressbook--importexport]
-file_filter = locale/<lang>/LC_MESSAGES/addressbook/importexport.po
-source_file = _build/locale/addressbook/importexport.pot
-source_lang = en
-
-[roundcube-webmail-help.addressbook--index]
-file_filter = locale/<lang>/LC_MESSAGES/addressbook/index.po
-source_file = _build/locale/addressbook/index.pot
-source_lang = en
-
-[roundcube-webmail-help.addressbook--searching]
-file_filter = locale/<lang>/LC_MESSAGES/addressbook/searching.po
-source_file = _build/locale/addressbook/searching.pot
-source_lang = en
-
-[roundcube-webmail-help.mail--compose]
-file_filter = locale/<lang>/LC_MESSAGES/mail/compose.po
-source_file = _build/locale/mail/compose.pot
-source_lang = en
-
-[roundcube-webmail-help.mail--importexport]
-file_filter = locale/<lang>/LC_MESSAGES/mail/importexport.po
-source_file = _build/locale/mail/importexport.pot
-source_lang = en
-
-[roundcube-webmail-help.mail--index]
-file_filter = locale/<lang>/LC_MESSAGES/mail/index.po
-source_file = _build/locale/mail/index.pot
-source_lang = en
-
-[roundcube-webmail-help.mail--mailview]
-file_filter = locale/<lang>/LC_MESSAGES/mail/mailview.po
-source_file = _build/locale/mail/mailview.pot
-source_lang = en
-
-[roundcube-webmail-help.mail--organization]
-file_filter = locale/<lang>/LC_MESSAGES/mail/organization.po
-source_file = _build/locale/mail/organization.pot
-source_lang = en
-
-[roundcube-webmail-help.mail--reading]
-file_filter = locale/<lang>/LC_MESSAGES/mail/reading.po
-source_file = _build/locale/mail/reading.pot
-source_lang = en
-
-[roundcube-webmail-help.mail--searching]
-file_filter = locale/<lang>/LC_MESSAGES/mail/searching.po
-source_file = _build/locale/mail/searching.pot
-source_lang = en
-
-[roundcube-webmail-help.settings--folders]
-file_filter = locale/<lang>/LC_MESSAGES/settings/folders.po
-source_file = _build/locale/settings/folders.pot
-source_lang = en
-
-[roundcube-webmail-help.settings--identities]
-file_filter = locale/<lang>/LC_MESSAGES/settings/identities.po
-source_file = _build/locale/settings/identities.pot
-source_lang = en
-
-[roundcube-webmail-help.settings--index]
-file_filter = locale/<lang>/LC_MESSAGES/settings/index.po
-source_file = _build/locale/settings/index.pot
-source_lang = en
-
-[roundcube-webmail-help.settings--preferences]
-file_filter = locale/<lang>/LC_MESSAGES/settings/preferences.po
-source_file = _build/locale/settings/preferences.pot
-source_lang = en
-
-[roundcube-webmail-help.settings--responses]
-file_filter = locale/<lang>/LC_MESSAGES/settings/responses.po
-source_file = _build/locale/settings/responses.pot
-source_lang = en
+
+[o:roundcube:p:roundcube-webmail-help:r:addressbook--addressbookview]
+file_filter            = source/locale/<lang>/LC_MESSAGES/addressbook/addressbookview.po
+source_file            = build/gettext/addressbook/addressbookview.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:addressbook--editing]
+file_filter            = source/locale/<lang>/LC_MESSAGES/addressbook/editing.po
+source_file            = build/gettext/addressbook/editing.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:addressbook--importexport]
+file_filter            = source/locale/<lang>/LC_MESSAGES/addressbook/importexport.po
+source_file            = build/gettext/addressbook/importexport.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:addressbook--index]
+file_filter            = source/locale/<lang>/LC_MESSAGES/addressbook/index.po
+source_file            = build/gettext/addressbook/index.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:addressbook--searching]
+file_filter            = source/locale/<lang>/LC_MESSAGES/addressbook/searching.po
+source_file            = build/gettext/addressbook/searching.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:index]
+file_filter            = source/locale/<lang>/LC_MESSAGES/index.po
+source_file            = build/gettext/index.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:login]
+file_filter            = source/locale/<lang>/LC_MESSAGES/login.po
+source_file            = build/gettext/login.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:mail--compose]
+file_filter            = source/locale/<lang>/LC_MESSAGES/mail/compose.po
+source_file            = build/gettext/mail/compose.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:mail--importexport]
+file_filter            = source/locale/<lang>/LC_MESSAGES/mail/importexport.po
+source_file            = build/gettext/mail/importexport.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:mail--index]
+file_filter            = source/locale/<lang>/LC_MESSAGES/mail/index.po
+source_file            = build/gettext/mail/index.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:mail--mailview]
+file_filter            = source/locale/<lang>/LC_MESSAGES/mail/mailview.po
+source_file            = build/gettext/mail/mailview.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:mail--organization]
+file_filter            = source/locale/<lang>/LC_MESSAGES/mail/organization.po
+source_file            = build/gettext/mail/organization.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:mail--reading]
+file_filter            = source/locale/<lang>/LC_MESSAGES/mail/reading.po
+source_file            = build/gettext/mail/reading.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:mail--searching]
+file_filter            = source/locale/<lang>/LC_MESSAGES/mail/searching.po
+source_file            = build/gettext/mail/searching.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:overview]
+file_filter            = source/locale/<lang>/LC_MESSAGES/overview.po
+source_file            = build/gettext/overview.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:settings--folders]
+file_filter            = source/locale/<lang>/LC_MESSAGES/settings/folders.po
+source_file            = build/gettext/settings/folders.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:settings--identities]
+file_filter            = source/locale/<lang>/LC_MESSAGES/settings/identities.po
+source_file            = build/gettext/settings/identities.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:settings--index]
+file_filter            = source/locale/<lang>/LC_MESSAGES/settings/index.po
+source_file            = build/gettext/settings/index.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:settings--preferences]
+file_filter            = source/locale/<lang>/LC_MESSAGES/settings/preferences.po
+source_file            = build/gettext/settings/preferences.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:settings--responses]
+file_filter            = source/locale/<lang>/LC_MESSAGES/settings/responses.po
+source_file            = build/gettext/settings/responses.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
+
+[o:roundcube:p:roundcube-webmail-help:r:sphinx]
+file_filter            = source/locale/<lang>/LC_MESSAGES/sphinx.po
+source_file            = build/gettext/sphinx.pot
+source_lang            = en
+replace_edited_strings = false
+keep_translations      = false
 

Makefile

@@ -1,42 +1,60 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SOURCE        = en_US
-VERSION       = 1.1
-LANGUAGE      = en
-INTL_LOCALES  = -l de -l fr -l sk
-# use tags to include documentation for specific plugins
-TAGS          = -t archive -t acl -t zipdownload -t v1.1
-SPHINXOPTS    = -c . -D language='$(LANGUAGE)' -D version='$(VERSION)' -D release='$(VERSION)'
-SPHINXBUILD   = sphinx-build
-SPHINXINTL    = sphinx-intl
-BUILDDIR      = _build
-
-ALLSPHINXOPTS = $(SPHINXOPTS) $(TAGS) -d $(BUILDDIR)/doctrees/$(SOURCE)
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCE) $(TAGS)
-
-all: html
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS   ?=
+SPHINXBUILD  ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Use the two-character language code here, else the .po files are not found.
+LANGUAGE     ?= en
+VERSION      ?= 1.1
+TAGS         ?= -t archive -t acl -t zipdownload
+
+
+.PHONY: help Makefile clean push-to-transifex pull-from-transifex en de fr sk pages
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 clean:
-	rm -rf $(BUILDDIR)/html
-	mkdir -p $(BUILDDIR)/locale/_plugins
-
-html: conf.py _static/default.css
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SOURCE) $(BUILDDIR)/html/doc/help/$(VERSION)/$(SOURCE)
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/doc/help/$(VERSION)/$(SOURCE)."
-
-gettext:
-	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
-	$(SPHINXINTL) update -p $(BUILDDIR)/locale -d locale $(INTL_LOCALES)
-	@echo
-	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-update-txconfig-resources:
-	@echo "Removing _plugins locale files..."
-	rm -rf locale/*/LC_MESSAGES/_plugins/*
-	rm -rf $(BUILDDIR)/locale/_plugins/*
-	$(SPHINXINTL) update-txconfig-resources --transifex-project-name roundcube-webmail-help -p $(BUILDDIR)/locale -d locale
-	@echo
-	@echo "Transifex resources have been updated."
+	rm -rvf build pages source/locale
+
+push-to-transifex: clean gettext
+	sphinx-intl update-txconfig-resources --transifex-organization-name roundcubemail --transifex-project-name roundcube-webmail-help
+	tx push -s
+
+pull-from-transifex: gettext
+	tx pull -l $(LANGUAGE)
+
+pages-mkdir:
+	mkdir -p pages/doc/help/$(VERSION)
+
+en: pages-mkdir
+	make html
+	mv -v build/html pages/doc/help/$(VERSION)/en_US
+	# Copy the generic index to all intermediate directories to provide links to the actual docs.
+	mv -v pages/doc/help/$(VERSION)/en_US/generic-index.html pages/index.html
+	sed -i -e 's#<head>#<head>\n<base href="/doc/help/1.1/en_US/">#' pages/index.html
+	cp -v pages/index.html pages/doc/
+	cp -v pages/index.html pages/doc/help/
+	cp -v pages/index.html pages/doc/help/$(VERSION)/
+
+de: pages-mkdir
+	make LANGUAGE=de pull-from-transifex html
+	mv -v build/html pages/doc/help/$(VERSION)/de_DE
+
+fr: pages-mkdir
+	make LANGUAGE=fr pull-from-transifex html
+	mv -v build/html pages/doc/help/$(VERSION)/fr_FR
+
+sk: pages-mkdir
+	make LANGUAGE=sk pull-from-transifex html
+	mv -v build/html pages/doc/help/$(VERSION)/sk_SK
+
+pages: clean en de fr sk
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -t v$(VERSION) $(TAGS) -D version=$(VERSION) -D language=$(LANGUAGE) $(SPHINXOPTS) $(O)