Commit ba0b1a7f authored by Thibault Saunier's avatar Thibault Saunier 🌵 Committed by Thibault Saunier
Browse files

Use meson to build the documentation

parent 09a884c8
all:
install:
clean:
BRANCH = 1.10
HOTDOC ?= hotdoc
prefix ?= /usr
datadir ?= ${prefix}/share
devhelpdir ?= ${datadir}/devhelp/books
docdir ?= ${datadir}/doc/${PACKAGE}
htmldir ?= ${docdir}
# emulate Automake well enough for hotdoc.mk
AM_V_GEN ?=
AMTAR ?= tar
mkinstalldirs ?= install -d
srcdir = $(CURDIR)
top_srcdir = $(CURDIR)
builddir = $(CURDIR)
top_builddir = $(CURDIR)
HOTDOC_PROJECTS = gst-docs
gst_docs_HOTDOC_FLAGS = \
--conf-file hotdoc.json \
$(NULL)
.PHONY: all install clean
-include $(shell $(HOTDOC) --makefile-path)
# These variables define the location of the online docs
#
# If your local username and your fdo username differ, you
# will need to add an entry for gstreamer.freedesktop.org
# in your ~/.ssh/config with the right username for the server.
#
# DOC_SERVER = people.freedesktop.org
# DOC_BASE = public_html/gst-docs
DOC_SERVER = gstreamer.freedesktop.org
DOC_BASE = /srv/gstreamer.freedesktop.org/public_html/documentation
# The local build directory with the generated HTML output
BUILT_DOC_DIR = $(builddir)/built_doc/html/
check-for-hotdoc:
@$(HOTDOC) --version >/dev/null 2>/dev/null
upload: check-for-hotdoc all
rsync -rvaz -e ssh --links --delete $(BUILT_DOC_DIR) $(DOC_SERVER):$(DOC_BASE) || /bin/true
ssh $(DOC_SERVER) "chmod -R g+w $(DOC_BASE); chgrp -R gstreamer $(DOC_BASE)"
include plugins-introspection/plugins-introspection.mak
help:
@echo
@echo " make -- Build or rebuild docs (markdown -> html)"
@echo
@echo " make upload -- Upload docs"
@echo
@echo " make update-xml -- Update local plugin module .xml files from git"
@echo " make update-plugin-list -- Rebuild local plugins.md list from .xml files"
@echo
@echo " make clean-url-cache -- Remove local url cache"
@echo
{
"project_version": "1.0",
"add_anchors": true,
"extra_assets": [
"images"
],
"index": "markdown/index.md",
"output": "built_doc",
"pkg_config_packages": [
"gstreamer-1.0"
],
"project_name": "GStreamer Documentation",
"project_version": "1.0",
"sitemap": "sitemap.txt",
"syntax_highlighting_activate": true,
"devhelp_activate": true,
"html_theme": "https://github.com/hotdoc/hotdoc_lumen_theme/releases/download/0.6/hotdoc_lumen_theme-0.6.tar.xz?sha256=0e2f175f4cf8c00ed7ac5014e30c806a294b0d3818565eb74e1424a948e8a452",
"html_extra_theme": "theme/extra",
"include_paths": ["examples"]
}
project('GStreamer manuals and tutorials', 'c', version: '1.11.1.1')
hotdoc = import('hotdoc')
apiversion = '1.0'
html_theme = 'https://github.com/hotdoc/hotdoc_lumen_theme/releases/download/0.9/hotdoc_lumen_theme-0.9.tar.xz?sha256=ec3807f13eda2d4914fcf251b7e9607e90f33430725a2b1d433a90c9210a52fc'
gstreamer_doc = hotdoc.generate_doc('GStreamer',
project_version: apiversion,
sitemap: 'sitemap.txt',
project_version: '1.0',
index: 'markdown/index.md',
build_by_default: true,
install: true,
extra_assets: [join_paths(meson.current_source_dir(), 'images')],
syntax_highlighting_activate: true,
html_theme: html_theme,
include_paths: join_paths(meson.current_source_dir(), 'examples'),
html_extra_theme: join_paths(meson.current_source_dir(), 'theme/extra'),
edit_on_github_repository: 'https://gitlab.freedesktop.org/gstreamer/gst-docs/',
edit_on_github_branch: 'master',
disable_incremental_build: true,
devhelp_activate: true,
)
\ No newline at end of file
......@@ -206,4 +206,4 @@ index.md
design/draft-tagreading.md
design/toc.md
design/tracing.md
design/trickmodes.md
design/trickmodes.md
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment