Skip to content

Commit 908528c

Browse files
committed
Move doxygentoasciidoc submodule into the lib directory, in common with other submodules
Also set a branch for the submodule, for easier updating
1 parent 5c708ab commit 908528c

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

.gitmodules

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88
branch = master
99

1010
[submodule "doxygentoasciidoc"]
11-
path = doxygentoasciidoc
11+
path = lib/doxygentoasciidoc
1212
url = https://github.com/raspberrypi/doxygentoasciidoc.git
13+
branch = main

Makefile

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ AUTO_NINJABUILD = $(BUILD_DIR)/autogenerated.ninja
1616

1717
PICO_SDK_DIR = lib/pico-sdk
1818
PICO_EXAMPLES_DIR = lib/pico-examples
19+
DOXYGEN_TO_ASCIIDOC_DIR = lib/doxygentoasciidoc
1920
ALL_SUBMODULE_CMAKELISTS = $(PICO_SDK_DIR)/CMakeLists.txt $(PICO_EXAMPLES_DIR)/CMakeLists.txt
2021
DOXYGEN_PICO_SDK_BUILD_DIR = build-pico-sdk-docs
2122
DOXYGEN_XML_DIR = $(DOXYGEN_PICO_SDK_BUILD_DIR)/combined/docs/doxygen/xml
@@ -51,10 +52,10 @@ $(PICO_EXAMPLES_DIR)/CMakeLists.txt: | $(PICO_SDK_DIR)/CMakeLists.txt $(PICO_EXA
5152
git submodule update --init $(PICO_EXAMPLES_DIR)
5253

5354
# Initialise doxygentoasciidoc submodule
54-
doxygentoasciidoc/__main__.py:
55-
git submodule update --init doxygentoasciidoc
55+
$(DOXYGEN_TO_ASCIIDOC_DIR)/__main__.py:
56+
git submodule update --init $(DOXYGEN_TO_ASCIIDOC_DIR)
5657

57-
fetch_submodules: $(ALL_SUBMODULE_CMAKELISTS) doxygentoasciidoc/__main__.py
58+
fetch_submodules: $(ALL_SUBMODULE_CMAKELISTS) $(DOXYGEN_TO_ASCIIDOC_DIR)/__main__.py
5859

5960
# Get rid of the submodules
6061
clean_submodules:
@@ -79,11 +80,11 @@ clean_doxygen_xml:
7980
rm -rf $(DOXYGEN_PICO_SDK_BUILD_DIR)
8081

8182
# create the sdk adoc and the json file
82-
$(ASCIIDOC_DOXYGEN_DIR)/picosdk_index.json $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc: $(ASCIIDOC_DOXYGEN_DIR) $(DOXYGEN_XML_DIR)/index.xml doxygentoasciidoc/__main__.py doxygentoasciidoc/cli.py doxygentoasciidoc/nodes.py doxygentoasciidoc/helpers.py | $(BUILD_DIR)
83+
$(ASCIIDOC_DOXYGEN_DIR)/picosdk_index.json $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc: $(ASCIIDOC_DOXYGEN_DIR) $(DOXYGEN_XML_DIR)/index.xml $(DOXYGEN_TO_ASCIIDOC_DIR)/__main__.py $(DOXYGEN_TO_ASCIIDOC_DIR)/cli.py $(DOXYGEN_TO_ASCIIDOC_DIR)/nodes.py $(DOXYGEN_TO_ASCIIDOC_DIR)/helpers.py | $(BUILD_DIR)
8384
$(MAKE) clean_ninja
84-
python3 -m doxygentoasciidoc -f $(DOXYGEN_XML_DIR)/index.xml > $(ASCIIDOC_DOXYGEN_DIR)/all_groups.adoc
85-
python3 -m doxygentoasciidoc -f $(DOXYGEN_XML_DIR)/indexpage.xml -c > $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc
86-
python3 -m doxygentoasciidoc -f $(DOXYGEN_XML_DIR)/examples_page.xml -c > $(ASCIIDOC_DOXYGEN_DIR)/examples_page.adoc
85+
PYTHONPATH=$(DOXYGEN_TO_ASCIIDOC_DIR)/.. python3 -m doxygentoasciidoc -f $(DOXYGEN_XML_DIR)/index.xml > $(ASCIIDOC_DOXYGEN_DIR)/all_groups.adoc
86+
PYTHONPATH=$(DOXYGEN_TO_ASCIIDOC_DIR)/.. python3 -m doxygentoasciidoc -f $(DOXYGEN_XML_DIR)/indexpage.xml -c > $(ASCIIDOC_DOXYGEN_DIR)/index_doxygen.adoc
87+
PYTHONPATH=$(DOXYGEN_TO_ASCIIDOC_DIR)/.. python3 -m doxygentoasciidoc -f $(DOXYGEN_XML_DIR)/examples_page.xml -c > $(ASCIIDOC_DOXYGEN_DIR)/examples_page.adoc
8788
python3 $(SCRIPTS_DIR)/postprocess_doxygen_adoc.py $(ASCIIDOC_DOXYGEN_DIR)
8889
-cp $(DOXYGEN_XML_DIR)/*.png $(ASCIIDOC_DOXYGEN_DIR) 2>/dev/null || true
8990

doxygentoasciidoc

Lines changed: 0 additions & 1 deletion
This file was deleted.

lib/doxygentoasciidoc

Submodule doxygentoasciidoc added at 278bc08

0 commit comments

Comments
 (0)