Skip to content

Commit

Permalink
Doc tool include common.xml in index
Browse files Browse the repository at this point in the history
  • Loading branch information
hamishwillee authored and LorenzMeier committed Sep 20, 2018
1 parent 580a9ce commit 9085488
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/mavlink_gitbook.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
index_text+='\n\nMAVLink protocol-specific and vendor-specific messages (dialects) are stored in separate XML files. These often include the [common](../messages/common.md) message definition, extending it with needed vendor or protocol specific messages.'
index_text+='\n\n> **Note** While a dialect can include any other message definition, care should be taken when including a definition file that includes another file (only a single level of nesting is tested).'
index_text+='\n\n<span></span>\n> **Note** Vendor forks of MAVLink may contain messages that are not yet merged, and hence will not appear in this documentation.'
index_text+='\n\nThe human-readable forms of the vendor XML files are linked below:'
index_text+='\n\nThe human-readable forms of all the XML files are linked below:'

#Fix up the BeautifulSoup output so to fix build-link errors in the generated gitbook.
## BS puts each tag/content in its own line. Gitbook generates anchors using the spaces/newlines.
Expand Down Expand Up @@ -134,8 +134,8 @@ def inject_top_level_docs(input_html,filename):
with open(output_file_name_withdir, 'w') as out:
out.write(prettyHTML )

if not file=='common.xml':
index_text+='\n* [%s](%s)' % (file,output_file_name)
#if not file=='common.xml':
index_text+='\n* [%s](%s)' % (file,output_file_name)

#Write the index - Disabled for now.
with open(index_file_name, 'w') as content_file:
Expand Down

0 comments on commit 9085488

Please sign in to comment.