diff --git a/Makefile b/Makefile index 8995c5335..28d54c337 100644 --- a/Makefile +++ b/Makefile @@ -83,6 +83,7 @@ $(ASCIIDOC_DOXYGEN_DIR)/picosdk_index.json $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen # create the sdk introduction python3 -m doxygentoasciidoc -f $(DOXYGEN_XML_DIR)/indexpage.xml -c > $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc python3 $(SCRIPTS_DIR)/postprocess_doxygen_adoc.py $(ASCIIDOC_DOXYGEN_DIR)/all_groups.adoc $(ASCIIDOC_DOXYGEN_DIR) + python3 $(SCRIPTS_DIR)/postprocess_doxygen_adoc.py $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc $(ASCIIDOC_DOXYGEN_DIR) -cp $(DOXYGEN_XML_DIR)/*.png $(ASCIIDOC_DOXYGEN_DIR) build_doxygen_adoc: $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc diff --git a/doxygentoasciidoc b/doxygentoasciidoc index 2398b53cf..1d8306556 160000 --- a/doxygentoasciidoc +++ b/doxygentoasciidoc @@ -1 +1 @@ -Subproject commit 2398b53cfc7f7bdc33297132c56b4cc473c73430 +Subproject commit 1d8306556608e90c696d08ed0ff00394490ec4e3 diff --git a/scripts/postprocess_doxygen_adoc.py b/scripts/postprocess_doxygen_adoc.py index b36c501cf..d5182ec47 100644 --- a/scripts/postprocess_doxygen_adoc.py +++ b/scripts/postprocess_doxygen_adoc.py @@ -3,6 +3,18 @@ import os import json +def cleanup_index_page(adoc_file, output_adoc_path): + script_path = os.path.realpath(__file__) + top_dir_path = re.sub(r'/scripts/.*$', "", script_path) + output_path = os.path.join(top_dir_path, output_adoc_path, "index_doxygen.adoc") + with open(adoc_file) as f: + adoc_content = f.read() + # remove any errant spaces before anchors + adoc_content = re.sub(r'( +)(\[\[[^[]*?\]\])', "\\2", adoc_content) + with open(adoc_file, 'w') as f: + f.write(adoc_content) + return + def build_json(sections, output_path): json_path = os.path.join(output_path, "picosdk_index.json") with open(json_path, 'w') as f: @@ -96,4 +108,7 @@ def postprocess_doxygen_adoc(adoc_file, output_adoc_path): if __name__ == '__main__': adoc_file = sys.argv[1] output_adoc_path = sys.argv[2] - postprocess_doxygen_adoc(adoc_file, output_adoc_path) + if re.search("index_doxygen.adoc", adoc_file) is not None: + cleanup_index_page(adoc_file, output_adoc_path) + else: + postprocess_doxygen_adoc(adoc_file, output_adoc_path)