From fd2c22c435423c8c849dbea90d80d4d82ef999df Mon Sep 17 00:00:00 2001 From: Thomas Schmidts Date: Tue, 23 Sep 2014 13:38:56 +0200 Subject: [PATCH] Added readme for creating the documentation and changed printout of the makefile --- Documentation/Books/bot.py | 9 +++--- Documentation/Books/codeBlockReader.py | 7 ++--- Documentation/Books/deprecated.py | 42 +++++++++++--------------- Documentation/Books/readme.txt | 5 +++ 4 files changed, 28 insertions(+), 35 deletions(-) create mode 100644 Documentation/Books/readme.txt diff --git a/Documentation/Books/bot.py b/Documentation/Books/bot.py index b3b38a586c..251f5ff358 100644 --- a/Documentation/Books/bot.py +++ b/Documentation/Books/bot.py @@ -13,7 +13,6 @@ def walk_on_files(dirpath): else: full_path= os.path.join(root, file) f=open(full_path,"rU") - print "checking file: " + full_path + file textFile=f.read() f.close() findStartCode(textFile,full_path) @@ -93,9 +92,9 @@ def replaceCodeIndex(pathOfFile): f.write(lines) f.close() - if __name__ == '__main__': - path = ["Documentation/Books/Users"] - for i in path: - dirpath = os.path.abspath(os.path.join(os.path.dirname( __file__ ), os.pardir,"ArangoDB/../../"+i)) + path = ["Documentation/Books/Users"] + for i in path: + dirpath = os.path.abspath(os.path.join(os.path.dirname( __file__ ), os.pardir,"ArangoDB/../../"+i)) + print "Replacing docublocks with content..." walk_on_files(dirpath) \ No newline at end of file diff --git a/Documentation/Books/codeBlockReader.py b/Documentation/Books/codeBlockReader.py index 3f5fd82090..604b9854ba 100644 --- a/Documentation/Books/codeBlockReader.py +++ b/Documentation/Books/codeBlockReader.py @@ -196,9 +196,6 @@ if __name__ == "__main__": "js/actions","js/client","js/apps/databases","js/apps/system/cerberus","js/apps/system/gharial","js/common","js/server"] for i in path: dirpath = os.path.abspath(os.path.join(os.path.dirname( __file__ ), os.pardir,"ArangoDB/../../"+i)) - print "Reading" + i fetch_comments(dirpath) - - - os.path.abspath(os.path.join(os.path.dirname( __file__ ), '..', 'templates')) - + print "Searching for docublocks in " + i + os.path.abspath(os.path.join(os.path.dirname( __file__ ), '..', 'templates')) \ No newline at end of file diff --git a/Documentation/Books/deprecated.py b/Documentation/Books/deprecated.py index 2b1b1ef4ca..8cb60d720a 100644 --- a/Documentation/Books/deprecated.py +++ b/Documentation/Books/deprecated.py @@ -6,17 +6,8 @@ def walk_on_files(dirpath): for root, dirs, files in os.walk(dirpath): for file in files: if file.endswith(".html"): - if file == "SUMMARY.md": - pass - elif file == "Index.md": - pass - else: - full_path= os.path.join(root, file) - f=open(full_path,"rU") - print "checking file: " + full_path - textFile=f.read() - f.close() - replaceCode(full_path) + full_path= os.path.join(root, file) + replaceCode(full_path) return def replaceCode(pathOfFile): @@ -25,22 +16,23 @@ def replaceCode(pathOfFile): s=f.read() f.close() f=open(pathOfFile,'w') - lines = s.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") - lines = lines.replace("","") + lines = s.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") + lines = lines.replace("","") f.write(lines) f.close() if __name__ == '__main__': - path = ["Documentation/Books/books/Users"] - for i in path: - dirpath = os.path.abspath(os.path.join(os.path.dirname( __file__ ), os.pardir,"ArangoDB/../../"+i)) + path = ["Documentation/Books/books/Users"] + for i in path: + dirpath = os.path.abspath(os.path.join(os.path.dirname( __file__ ), os.pardir,"ArangoDB/../../"+i)) + print "Tagging deprecated files" walk_on_files(dirpath) \ No newline at end of file diff --git a/Documentation/Books/readme.txt b/Documentation/Books/readme.txt new file mode 100644 index 0000000000..a09eb4dec8 --- /dev/null +++ b/Documentation/Books/readme.txt @@ -0,0 +1,5 @@ +How to generate the documentation: + +1. Install markdown-pp from our repository (https://github.com/triAGENS/markdown-pp) +2. Install gitbook (https://github.com/GitbookIO/gitbook) +3. Run "make" in this folder