mirror of
https://github.com/bluekitchen/btstack.git
synced 2025-03-29 22:20:37 +00:00
doc: rename scripts
This commit is contained in:
parent
503a627eda
commit
c8c342a60c
5
doc/manual/.gitignore
vendored
5
doc/manual/.gitignore
vendored
@ -1,8 +1,7 @@
|
||||
btstack
|
||||
btstack.pdf
|
||||
docs
|
||||
docs_tmp
|
||||
docs-markdown
|
||||
latex
|
||||
mkdocs.yml
|
||||
api_index.md
|
||||
tmp
|
||||
references.p
|
@ -24,17 +24,17 @@ docs-markdown:
|
||||
|
||||
# create docs-markdown/appendix/apis.md
|
||||
# create docs-markdown/api_index.md
|
||||
# create docs-markdown/references.p
|
||||
./update_apis.py -r ${BTSTACK_FOLDER} -g ${GITHUB_URL} -o ${MARKDOWN_FOLDER}
|
||||
# create references.p
|
||||
./markdown_create_apis.py -r ${BTSTACK_FOLDER} -g ${GITHUB_URL} -o ${MARKDOWN_FOLDER}
|
||||
|
||||
# create docs-markdown/examples/examples.md
|
||||
./update_listings.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER}
|
||||
./markdown_create_examples.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER}
|
||||
|
||||
# create docs-markdown/ports/existing_ports.md
|
||||
./ports2markdown.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER}
|
||||
./markdown_create_ports.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER}
|
||||
|
||||
# create docs-markdown/gatt_clients.md and docs-template/gatt_services.md
|
||||
./update_gatt_services.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER}
|
||||
./markdown_create_gatt_services_and_clients.py -r ${BTSTACK_FOLDER} -t ${INTRO_FOLDER} -o ${MARKDOWN_FOLDER}
|
||||
|
||||
docs: docs-markdown
|
||||
# create new docs_final
|
||||
@ -42,15 +42,15 @@ docs: docs-markdown
|
||||
cp -r docs-markdown docs
|
||||
|
||||
# docs-markdown -> docs
|
||||
./markdown2mkdocs.py -i ${MARKDOWN_FOLDER} -o ${MKDOCS_FOLDER}
|
||||
./markdown_update_references.py -i ${MARKDOWN_FOLDER} -o ${MKDOCS_FOLDER}
|
||||
|
||||
|
||||
html: docs
|
||||
# generate HTML into btstack folder
|
||||
mkdocs build --clean
|
||||
|
||||
# post-process HTML using docs-markdown/references.p
|
||||
./mkdocs2html.py -i ${MARKDOWN_FOLDER} -o ${HTML_FOLDER}
|
||||
# post-process HTML using references.p
|
||||
./html_postprocess_code_blocks.py -o ${HTML_FOLDER}
|
||||
|
||||
pdf: docs
|
||||
rm -rf latex
|
||||
@ -72,6 +72,6 @@ preview: docs
|
||||
clean:
|
||||
rm -rf docs-markdown docs tmp btstack *.pdf latex/btstack_generated.* latex/btstack_final.tex mkdocs.yml
|
||||
rm -rf latex btstack help
|
||||
|
||||
rm -rf references.p
|
||||
|
||||
|
||||
|
@ -14,10 +14,10 @@ def writeCodeBlock(aout, code, references):
|
||||
def main(argv):
|
||||
htmlfolder = "btstack/"
|
||||
|
||||
cmd = 'mkdocs2html.py [-i <markdownfolder>] [-o <htmlkfolder>]'
|
||||
cmd = 'html_postprocess_code_blocks.py [-o <htmlkfolder>]'
|
||||
|
||||
try:
|
||||
opts, args = getopt.getopt(argv,"i:o:",["ifolder", "ofolder="])
|
||||
opts, args = getopt.getopt(argv,"o:",["ofolder="])
|
||||
except getopt.GetoptError:
|
||||
print (cmd)
|
||||
sys.exit(2)
|
||||
@ -27,15 +27,13 @@ def main(argv):
|
||||
sys.exit()
|
||||
elif opt in ("-o", "--ofolder"):
|
||||
htmlfolder = arg
|
||||
elif opt in ("-i", "--ifolder"):
|
||||
markdownfolder = arg
|
||||
|
||||
|
||||
html_path = htmlfolder + "examples/"
|
||||
html_tmppath = htmlfolder + "examples/tmp/"
|
||||
|
||||
html_in = html_path + "examples/index.html"
|
||||
html_tmp = html_tmppath + "index.html"
|
||||
references = pickle.load(open( markdownfolder + "references.p", "rb" ))
|
||||
references = pickle.load(open( "references.p", "rb" ))
|
||||
|
||||
Path(html_tmppath).mkdir(parents=True, exist_ok=True)
|
||||
|
@ -222,7 +222,7 @@ def main(argv):
|
||||
githuburl = "https://github.com/bluekitchen/btstack/blob/master/"
|
||||
markdownfolder = "docs-markdown/"
|
||||
|
||||
cmd = 'update_apis.py [-r <root_btstackfolder>] [-g <githuburl>] [-o <output_markdownfolder>]'
|
||||
cmd = 'markdown_create_apis.py [-r <root_btstackfolder>] [-g <githuburl>] [-o <output_markdownfolder>]'
|
||||
try:
|
||||
opts, args = getopt.getopt(argv,"r:g:o:",["rfolder=","github=","ofolder="])
|
||||
except getopt.GetoptError:
|
||||
@ -240,7 +240,7 @@ def main(argv):
|
||||
markdownfolder = arg
|
||||
|
||||
apifile = markdownfolder + "appendix/apis.md"
|
||||
indexfile = markdownfolder + "api_index.md"
|
||||
# indexfile = markdownfolder + "api_index.md"
|
||||
|
||||
try:
|
||||
output = subprocess.check_output("git symbolic-ref --short HEAD", stderr=subprocess.STDOUT, timeout=3, shell=True)
|
||||
@ -255,7 +255,7 @@ def main(argv):
|
||||
print ('BTstack folder is : ' + btstackfolder)
|
||||
print ('API file is : ' + apifile)
|
||||
print ('Github URL is : ' + githuburl)
|
||||
print ('Index file is : ' + indexfile)
|
||||
# print ('Index file is : ' + indexfile)
|
||||
|
||||
writeAPI(apifile, btstackfolder, apis, mk_codeidentation)
|
||||
createIndex(btstackfolder, apis, githuburl)
|
||||
@ -268,11 +268,11 @@ def main(argv):
|
||||
references = functions.copy()
|
||||
references.update(typedefs)
|
||||
|
||||
with open(indexfile, 'w') as fout:
|
||||
for function, reference in references.items():
|
||||
fout.write("[" + function + "](" + reference + ")\n")
|
||||
# with open(indexfile, 'w') as fout:
|
||||
# for function, reference in references.items():
|
||||
# fout.write("[" + function + "](" + reference + ")\n")
|
||||
|
||||
pickle.dump(references, open( markdownfolder + "references.p", "wb" ) )
|
||||
pickle.dump(references, open("references.p", "wb" ) )
|
||||
|
||||
if __name__ == "__main__":
|
||||
main(sys.argv[1:])
|
@ -342,7 +342,7 @@ def main(argv):
|
||||
btstackfolder = "../../"
|
||||
git_branch_name = "master"
|
||||
|
||||
cmd = 'update_listings.py [-r <root_btstackfolder>] [-t <templatefolder>] [-o <output_markdownfolder>]'
|
||||
cmd = 'markdown_create_examples.py [-r <root_btstackfolder>] [-t <templatefolder>] [-o <output_markdownfolder>]'
|
||||
|
||||
try:
|
||||
opts, args = getopt.getopt(argv,"r:t:o:",["rfolder=","tfolder=","ofolder="])
|
@ -120,7 +120,7 @@ def main(argv):
|
||||
markdownfolder = "docs-markdown/"
|
||||
templatefolder = "docs-intro/"
|
||||
|
||||
cmd = 'update_gatt_services.py [-r <root_btstackfolder>] [-t <templatefolder>] [-o <output_markdownfolder>]'
|
||||
cmd = 'markdown_create_gatt_services_and_clients.py [-r <root_btstackfolder>] [-t <templatefolder>] [-o <output_markdownfolder>]'
|
||||
|
||||
try:
|
||||
opts, args = getopt.getopt(argv,"r:t:o:",["rfolder=","tfolder=","ofolder="])
|
@ -80,7 +80,7 @@ def main(argv):
|
||||
markdownfolder = "docs-markdown/"
|
||||
templatefolder = "docs-intro/"
|
||||
|
||||
cmd = 'ports2markdown.py [-r <root_btstackfolder>] [-t <templatefolder>] [-o <output_markdownfolder>]'
|
||||
cmd = 'markdown_create_ports.py [-r <root_btstackfolder>] [-t <templatefolder>] [-o <output_markdownfolder>]'
|
||||
|
||||
try:
|
||||
opts, args = getopt.getopt(argv,"r:t:o:",["rfolder=","tfolder=","ofolder="])
|
@ -72,7 +72,7 @@ def main(argv):
|
||||
markdownfolder = "docs-markdown/"
|
||||
mkdocsfolder = "docs/"
|
||||
|
||||
cmd = 'markdown2mkdocs.py [-i <markdownfolder>] [-o <mkdocsfolder>] '
|
||||
cmd = 'markdown_update_references.py [-i <markdownfolder>] [-o <mkdocsfolder>] '
|
||||
|
||||
try:
|
||||
opts, args = getopt.getopt(argv,"i:o:",["ifolder=","ofolder="])
|
Loading…
x
Reference in New Issue
Block a user