Pārlūkot izejas kodu

HUE-2890 [doc] Move manual to its own Admin manual section

Romain Rigaux 8 gadi atpakaļ
vecāks
revīzija
1c0c9be
3 mainītis faili ar 18 papildinājumiem un 6 dzēšanām
  1. 16 4
      docs/Makefile
  2. 1 1
      docs/admin-manual/manual.md
  3. 1 1
      docs/index.txt

+ 16 - 4
docs/Makefile

@@ -31,14 +31,13 @@ NO_TOC := --xsltproc-opts='--stringparam generate.toc ""'
 # Being lazy/loose with the prerequisite. Include all files except sdk and
 # release notes, which are handled separately below.
 #
-DOC_FILES := $(shell find . -name sdk -prune -o -name release-notes -name user-guide -o -print)
-$(BLD_DIR_DOC): sdk release-notes user-guide $(DOC_FILES)
+DOC_FILES := $(shell find . -name sdk -prune -o -name release-notes -name user-guide -name admin-manual -o -print)
+$(BLD_DIR_DOC): sdk release-notes user-guide admin-manual $(DOC_FILES)
 	@echo '--- Generating doc at $@'
 	@mkdir -p $@
 
 	@a2x $(NO_TOC) --icons --icons-dir=images --format=xhtml --stylesheet=docbook.css -D $@ index.txt
-	@a2x --asciidoc-opts="-a toc.max.depth=4" --format=xhtml --icons --icons-dir=images --stylesheet=docbook.css -D $@ manual.txt
-	@rm -f {index,manual}.xml
+	@rm -f index.xml
 
 	@cp docbook.css $@
 	@# Remove intermediate file
@@ -61,6 +60,19 @@ $(BLD_DIR_DOC)/release-notes: $(wildcard release-notes/*.txt)
 	@echo "--- Generated $@"
 
 
+.PHONY: admin-manual
+admin-manual: $(BLD_DIR_DOC)/admin-manual
+$(BLD_DIR_DOC)/admin-manual: $(wildcard admin-manual/*.md)
+	@echo '--- Generating admin-manual doc at $@'
+	@mkdir -p $@
+	@cp docbook.css $@
+	@cp bootplus.css $@
+	@PYTHONPATH=$(DESKTOP_DIR)/core/ext-py/markdown:$(DESKTOP_DIR)/core/ext-py/elementtree \
+	  $(DESKTOP_DIR)/core/ext-py/markdown/bin/markdown \
+	  admin-manual/manual.md -x toc > $@/manual.html
+	@echo "--- Generated $@"
+
+
 .PHONY: user-guide
 user-guide: $(BLD_DIR_DOC)/user-guide
 $(BLD_DIR_DOC)/user-guide: $(wildcard user-guide/*.md)

+ 1 - 1
docs/manual.txt → docs/admin-manual/manual.md

@@ -3,7 +3,7 @@
 <link rel="stylesheet" href="bootplus.css" type="text/css" media="screen" title="no title" charset="utf-8"></link>
 
 
-<h1><a href=index.html>Doc</a> > Hue Installation Guide</h1>
+<h1><a href=../index.html>Doc</a> > Hue Installation Guide</h1>
 
 
 <div class="row-fluid">

+ 1 - 1
docs/index.txt

@@ -3,7 +3,7 @@ image:images/hue_logo.png[Hue Logo]
 
 Administrate
 ------------
-The link:manual.html[manual] has instructions to install and administrate Hue.
+The link:admin-manual/manual.html[manual] has instructions to install and administrate Hue.
 
 User Guide
 ----------