mirror of
https://github.com/bluekitchen/btstack.git
synced 2025-03-01 01:13:23 +00:00
doc: fix title levels
This commit is contained in:
parent
fe776b3ce2
commit
3b261e460e
@ -1,3 +1,5 @@
|
||||
#
|
||||
|
||||
In this chapter, we first explain how Bluetooth chipsets are connected physically and then provide information about popular Bluetooth chipset and their use with BTstack.
|
||||
|
||||
## HCI Interface
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
## L2CAP Events {#sec:eventsAndErrorsAppendix}
|
||||
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
As well as any other communication stack, BTstack is a collection of
|
||||
state machines that interact with each other. There is one or more state
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
BTstack implements a set of Bluetooth protocols and profiles. To connect to other Bluetooth devices or to provide a Bluetooth services, BTstack has to be properly configured.
|
||||
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
While the run loop provided by BTstack is sufficient for new designs,
|
||||
BTstack is often used with or added to existing projects. In this case,
|
||||
|
@ -1,3 +1,5 @@
|
||||
#
|
||||
|
||||
In this section, we highlight the BTstack components that need to be
|
||||
adjusted for different hardware platforms.
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
|
||||
#
|
||||
|
||||
In the following, we explain how the various Bluetooth profiles are used
|
||||
in BTstack.
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
BTstack is a modular dual-mode Bluetooth stack, supporting both
|
||||
Bluetooth Basic Rate/Enhanced Date Rate (BR/EDR) as well as Bluetooth
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
## General Tools
|
||||
|
||||
|
@ -56,9 +56,14 @@ def process_readmes(intro_file, port_folder, ports_file, ports_folder):
|
||||
for line in fin:
|
||||
#increase level of indentation
|
||||
parts = re.match('#(.*)\n',line)
|
||||
title_parts = re.match('(#\s+)(.*)\n',line)
|
||||
if parts and title_parts:
|
||||
ports.write("# " + title_parts.group(2) + " {" + "#sec:" + readme_dir + "Port}\n" )
|
||||
|
||||
title_parts_level1 = re.match('(#\s+)(.*)\n',line)
|
||||
title_parts_level2 = re.match('(##\s+)(.*)\n',line)
|
||||
|
||||
if parts and title_parts_level1:
|
||||
ports.write("## " + title_parts_level1.group(2) + " {" + "#sec:" + readme_dir + "Port}\n" )
|
||||
elif parts and title_parts_level2:
|
||||
ports.write("### " + title_parts_level2.group(2)+ "\n" )
|
||||
else:
|
||||
ports.write(line)
|
||||
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
In this section, we will describe a number of examples from the
|
||||
*example* folder. Here is a list of existing examples:
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
BTstack allows to implement and use GATT Clients in a modular way.
|
||||
|
||||
|
@ -1,3 +1,4 @@
|
||||
#
|
||||
|
||||
BTstack allows to implement and use GATT Services in a modular way.
|
||||
|
||||
|
@ -1 +1,3 @@
|
||||
Here is a list of existing ports:
|
||||
#
|
||||
|
||||
## Existing ports
|
||||
|
@ -100,6 +100,7 @@ def codeReference(fname, githubfolder, filepath, linenr):
|
||||
|
||||
def writeAPI(apifile, btstackfolder, apis, mk_codeidentation):
|
||||
with open(apifile, 'w') as fout:
|
||||
fout.write("#\n\n")
|
||||
for api_tuple in apis:
|
||||
api_filename = btstackfolder + api_tuple[0]
|
||||
api_title = api_tuple[1]
|
||||
|
@ -29,7 +29,7 @@ abrevations = {
|
||||
}
|
||||
|
||||
description_template = """
|
||||
### NAME {#sec:REFERENCE}
|
||||
## NAME {#sec:REFERENCE}
|
||||
|
||||
"""
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user