mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-04-06 10:20:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

manual: script takes cmd line params

Browse Source
This commit is contained in:
Milanka Ringwald 2015-04-24 10:00:17 +02:00
parent 88f21ad11b
commit 4b0c7d42c3
2 changed files with 61 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manual/Makefile
View File

@ -1,11 +1,11 @@
pdf: clean pdf: clean
python update_listings.py ./update_listings.py
pdflatex btstack_gettingstarted.tex pdflatex btstack_gettingstarted.tex
pdflatex btstack_gettingstarted.tex pdflatex btstack_gettingstarted.tex
open btstack_gettingstarted.pdf open btstack_gettingstarted.pdf
example: example:
python update_listings.py ./update_listings.py -s 1
subl examples.tex subl examples.tex
pdflatex examples.tex pdflatex examples.tex
open examples.pdf open examples.pdf

94
docs/manual/update_listings.py
View File

@ -1,11 +1,7 @@
#!/usr/bin/env python #!/usr/bin/env python
import os import os
import re import re
import sys import sys, getopt
docs_folder = ""
appendix_file = docs_folder + "examples.tex"
stand_alone_doc = 1
lst_header = """ lst_header = """
\\begin{lstlisting} \\begin{lstlisting}
@ -75,12 +71,12 @@ list_of_examples = {
class State: class State:
SearchExampleStart = 0 SearchExampleStart = 0
SearchListingStart = 2 SearchListingStart = 1
SearchListingPause = 4 SearchListingPause = 2
SearchListingResume = 5 SearchListingResume = 3
SearchListingEnd = 6 SearchListingEnd = 4
SearchItemizeEnd = 7 SearchItemizeEnd = 5
ReachedExampleEnd = 8 ReachedExampleEnd = 6
def replacePlaceholder(template, title, lable): def replacePlaceholder(template, title, lable):
snippet = template.replace("API_TITLE", title).replace("API_LABLE", lable) snippet = template.replace("API_TITLE", title).replace("API_LABLE", lable)
@ -132,7 +128,7 @@ def processTextLine(line):
return "" return ""
def writeListings(fout, infile_name): def writeListings(aout, infile_name):
itemText = None itemText = None
state = State.SearchExampleStart state = State.SearchExampleStart
code_in_listing = "" code_in_listing = ""
@ -234,33 +230,57 @@ def writeListings(fout, infile_name):
# write list of examples # write list of examples
with open(appendix_file, 'w') as aout: def processExamples(examples_file, stand_alone_doc):
if stand_alone_doc: with open(examples_file, 'w') as aout:
aout.write(document_begin) if stand_alone_doc:
aout.write(examples_header) aout.write(document_begin)
aout.write("\n \\begin{itemize}\n"); aout.write(examples_header)
aout.write("\n \\begin{itemize}\n");
for group_title, examples in list_of_examples.iteritems(): for group_title, examples in list_of_examples.iteritems():
group_title = group_title + " example" group_title = group_title + " example"
if len(examples) > 1: if len(examples) > 1:
group_title = group_title + "s" group_title = group_title + "s"
group_title = group_title + ":" group_title = group_title + ":"
aout.write(" \item " + group_title + "\n"); aout.write(" \item " + group_title + "\n");
aout.write(" \\begin{itemize}\n"); aout.write(" \\begin{itemize}\n");
for example in examples: for example in examples:
lable = example[1] lable = example[1]
title = latexText(example[1]) title = latexText(example[1])
desc = latexText(example[2]) desc = latexText(example[2])
aout.write(example_item.replace("EXAMPLE_TITLE", title).replace("EXAMPLE_DESC", desc).replace("EXAMPLE_LABLE", lable)) aout.write(example_item.replace("EXAMPLE_TITLE", title).replace("EXAMPLE_DESC", desc).replace("EXAMPLE_LABLE", lable))
aout.write(" \\end{itemize}\n") aout.write(" \\end{itemize}\n")
aout.write("\\end{itemize}\n") aout.write("\\end{itemize}\n")
for group_title, examples in list_of_examples.iteritems(): for group_title, examples in list_of_examples.iteritems():
for example in examples: for example in examples:
file_name = example[0] + example[1] + ".c" file_name = example[0] + example[1] + ".c"
writeListings(aout, file_name) writeListings(aout, file_name)
if stand_alone_doc: if stand_alone_doc:
aout.write(document_end) aout.write(document_end)
def main(argv):
outputfile = "examples.tex"
standalone_flag = 0
try:
opts, args = getopt.getopt(argv,"hs:o:",["sflag=","ofile="])
except getopt.GetoptError:
print 'test.py [-s <standaloneflag>] [-o <outputfile>]'
sys.exit(2)
for opt, arg in opts:
if opt == '-h':
print 'update_listings.py [-s <standalone_flag>] [-o <outputfile>]'
sys.exit()
elif opt in ("-s", "--sflag"):
standalone_flag = arg
elif opt in ("-o", "--ofile"):
outputfile = arg
print 'Standalone flag is ', standalone_flag
print 'Output file is ', outputfile
processExamples(outputfile, standalone_flag)
if __name__ == "__main__":
main(sys.argv[1:])