summaryrefslogtreecommitdiffstats
path: root/Makefile
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2014-06-17 10:37:25 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2014-06-26 11:07:10 +0200
commit3fef396bb42efc0bb12b0a8caf0d076ab1c4d879 (patch)
tree91625b2407ed25dffd093b19159135481eb80f84 /Makefile
parent7e65163b9165bccca780da91fad247c0e4ac7f9f (diff)
downloadbarebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.gz
barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.xz
Documentation: Add new sphinxs docs
This is a rewrite of the Documentation in reStructuredText format using Sphinx as build system, see http://sphinx-doc.org/. The documentation is built into static html pages with 'make docs'. The pages can be found under Documentation/html after building. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile11
1 files changed, 9 insertions, 2 deletions
diff --git a/Makefile b/Makefile
index e7e1679163..6dad637447 100644
--- a/Makefile
+++ b/Makefile
@@ -1076,8 +1076,7 @@ help:
@echo ' enough build support to build external modules'
@echo ' mrproper - Remove all generated files + config + various backup files'
@echo ' distclean - mrproper + remove editor backup and patch files'
- @echo ' docs - start doxygen for all output types (only HTML - FIXME)'
- @echo ' htmldocs - create documentation in HTML format'
+ @echo ' docs - build documentation
@echo ''
@echo 'Configuration targets:'
@$(MAKE) -f $(srctree)/scripts/kconfig/Makefile help
@@ -1125,6 +1124,14 @@ quiet_cmd_tags = GEN $@
tags TAGS cscope: FORCE
$(call cmd,tags)
+SPHINXBUILD = sphinx-build
+ALLSPHINXOPTS = source
+
+docs: FORCE
+ @mkdir -p $(srctree)/Documentation/commands
+ @$(srctree)/Documentation/gen_commands.py $(srctree) $(srctree)/Documentation/commands
+ @$(SPHINXBUILD) -b html -d $(objtree)/doctrees $(srctree)/Documentation \
+ $(objtree)/Documentation/html
endif #ifeq ($(config-targets),1)
endif #ifeq ($(mixed-targets),1)