# Makefile for Sphinx documentation SPHINX_BUILD = sphinx-build CONFIG_DIR = . SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSION) \ -D versions=$(VERSIONS) -D languages=$(LANGUAGES) -D language=$(CURRENT_LANG) \ -A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) SOURCE_DIR = content BUILD_DIR = _build ifeq ($(CURRENT_LANG),en) L10N_HTML_BUILD_DIR = $(BUILD_DIR)/html else L10N_HTML_BUILD_DIR = $(BUILD_DIR)/html/$(CURRENT_LANG) endif # Rely on COMSPEC, which is a variable present in all Windows platforms, to determine the OS ifdef COMSPEC RM_CMD ?= del else RM_CMD ?= rm -rf endif #=== Standard rules ===# # In first position to build the documentation from scratch by default all: html help: @echo "Please use 'make ' where is one of" @echo " html to build the documentation to HTML" @echo " fast to build the documentation to HTML with shallow menu (faster)" @echo " clean to delete the build files" clean: @echo "Cleaning build files..." $(RM_CMD) $(BUILD_DIR)/* $(RM_CMD) extensions/odoo_theme/static/style.css @echo "Cleaning finished." html: extensions/odoo_theme/static/style.css @echo "Starting build..." $(SPHINX_BUILD) -c $(CONFIG_DIR) -b html $(SPHINXOPTS) $(SOURCE_DIR) $(L10N_HTML_BUILD_DIR) @echo "Build finished." # NOTE: latexmk needed for latex build # NOTE: on linux MINT: # installed texlive-fonts-recommended texlive-latex-extra texlive-generic-recommended texlive-fonts-extra # FIXME ANVFE: the cp command is needed if we want the pdf files to be available in local # NOTE VFE: should be done after the make html latexpdf: @echo "Starting build..." $(SPHINX_BUILD) -c $(CONFIG_DIR) -b latex $(SPHINXOPTS) $(SOURCE_DIR) $(BUILD_DIR)/latex $(MAKE) -C $(BUILD_DIR)/latex cp $(BUILD_DIR)/latex/*.pdf $(BUILD_DIR)/html/ @echo "Build finished." # TODO update sphinx-intl command to take args l10n: @echo "Generating translatable files..." $(SPHINX_BUILD) -c $(CONFIG_DIR) -b gettext $(SOURCE_DIR) $(BUILD_DIR)/gettext @echo "Generation finished." @echo "Localizing translation strings..." sphinx-intl update -p $(BUILD_DIR)/gettext -l es_AR -l pt_BR @echo "Localization finished." extensions/odoo_theme/static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss @echo "Compiling stylesheets..." pysassc $(subst .css,.scss,$@) $@ @echo "Compilation finished." #=== Development and debug rules ===# fast: SPHINXOPTS += -A collapse_menu=True fast: html static: extensions/odoo_theme/static/style.css cp -r extensions/odoo_theme/static/* _build/html/_static/ cp -r static/* _build/html/_static/ # TODO REMOVE ME BEFORE MERGE edi: make clean html CANONICAL_VERSION=14.0 VERSIONS=12.0,13.0,14.0,master LANGUAGES=en,fr,es CURRENT_LANG=en lang: make clean make html CANONICAL_VERSION=14.0 VERSIONS=12.0,13.0,14.0,master LANGUAGES=en,fr,es CURRENT_LANG=en make html CANONICAL_VERSION=14.0 VERSIONS=12.0,13.0,14.0,master LANGUAGES=en,fr,es CURRENT_LANG=fr make html CANONICAL_VERSION=14.0 VERSIONS=12.0,13.0,14.0,master LANGUAGES=en,fr,es CURRENT_LANG=es