[gnome-builder] build: generate html docs and ship them in the tarball
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder] build: generate html docs and ship them in the tarball
- Date: Thu, 9 Mar 2017 08:21:22 +0000 (UTC)
commit 28f7db9cedea501b6e8b982f81e707c740d85d99
Author: Christian Hergert <chergert redhat com>
Date: Wed Mar 8 23:39:35 2017 -0800
build: generate html docs and ship them in the tarball
These will get installed to $(docdir)/html which ends up being something
like /opt/gnome/share/doc/gnome-builder/html. We can use these to show
documentation locally without loading an internet site.
Additionally, we can use the doctree files if we want to navigate docs
locally within Builder.
doc/Makefile.am | 100 ++++++++++++++++++++++++++++++++++--------------------
1 files changed, 63 insertions(+), 37 deletions(-)
---
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 5fdeb53..47aded7 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,45 +1,71 @@
SUBDIRS = examples
-EXTRA_DIST = \
- credits.rst \
- plugins/running.rst \
- plugins/building/pipeline.rst \
- plugins/building/buildsystem.rst \
- plugins/building/index.rst \
- plugins/keybindings.rst \
- plugins/editor/highlighting.rst \
- plugins/editor/buffers.rst \
- plugins/editor/index.rst \
- plugins/editor/snippets.rst \
- plugins/editor/autocompletion.rst \
- plugins/editor/filesettings.rst \
- plugins/editor/diagnostics.rst \
- plugins/transfers.rst \
- plugins/workers.rst \
- plugins/headerbar.rst \
- plugins/greeter.rst \
- plugins/langserv.rst \
- plugins/index.rst \
- plugins/search.rst \
- plugins/symbols/index.rst \
- plugins/symbols/symbols.rst \
- plugins/symbols/rename.rst \
- plugins/symbols/gotodef.rst \
- plugins/devices.rst \
- plugins/vcs.rst \
- plugins/creating.rst \
- plugins/processes/runtimes.rst \
+EXTRA_DIST = \
+ api/index.rst \
+ contributing/code.rst \
+ contributing/index.rst \
+ contributing/planning.rst \
+ contributing/writingdocs.rst \
+ credits.rst \
+ exploring.rst \
+ index.rst \
+ installation.rst \
+ plugins/building/buildsystem.rst \
+ plugins/building/index.rst \
+ plugins/building/pipeline.rst \
+ plugins/creating.rst \
+ plugins/devices.rst \
+ plugins/editor/autocompletion.rst \
+ plugins/editor/buffers.rst \
+ plugins/editor/diagnostics.rst \
+ plugins/editor/filesettings.rst \
+ plugins/editor/highlighting.rst \
+ plugins/editor/index.rst \
+ plugins/editor/snippets.rst \
+ plugins/greeter.rst \
+ plugins/index.rst \
+ plugins/keybindings.rst \
+ plugins/langserv.rst \
+ plugins/menus.rst \
+ plugins/preferences.rst \
+ plugins/processes/index.rst \
+ plugins/processes/runtimes.rst \
plugins/processes/subprocesses.rst \
- plugins/processes/index.rst \
- plugins/workbench.rst \
- plugins/preferences.rst \
- exploring.rst \
- api/index.rst \
- index.rst \
- installation.rst \
- contributing.rst \
+ plugins/running.rst \
+ plugins/search.rst \
+ plugins/symbols/gotodef.rst \
+ plugins/symbols/index.rst \
+ plugins/symbols/rename.rst \
+ plugins/symbols/symbols.rst \
+ plugins/transfers.rst \
+ plugins/vcs.rst \
+ plugins/workbench/actions.rst \
+ plugins/workbench/basics.rst \
+ plugins/workbench/headerbar.rst \
+ plugins/workbench/index.rst \
+ plugins/workbench/panels.rst \
+ plugins/workbench/perspectives.rst \
+ plugins/workbench/widgets.rst \
+ plugins/workers.rst \
+ projects/building.rst \
+ projects/creating.rst \
+ projects/debugging.rst \
+ projects/index.rst \
+ projects/profiling.rst \
+ projects/sharing.rst \
$(NULL)
+SPHINX_BUILD = sphinx-build
+
+dist-hook:
+ rm -rf html ; $(SPHINX_BUILD) "$(top_srcdir)/doc" "$(distdir)/html"
+
+install-data-hook:
+ if test -d "$(srcdir)/html"; then \
+ $(MKDIR_P) "$(DESTDIR)$(docdir)/html" ; \
+ cp -a html/* "$(DESTDIR)$(docdir)/html/" ; \
+ fi
+
GITIGNOREFILES = _build
-include $(top_srcdir)/git.mk
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]