Merge pull request raspberrypi#2156 from raspberrypi/kill_extra_html

Alasdair Allan · web-flow · commit ad3da9ab9632 · 2021-09-15T16:16:42.000+01:00
Prevent extraneous HTML files being created
diff --git a/makefiles/jekyll.mk b/makefiles/jekyll.mk
@@ -7,6 +7,7 @@ MARKER_FILE = $(OUTPUT_DIR)/.done
 NEXT_MAKEFILE = makefiles/html.mk
 
 AUTO_NINJABUILD = $(BUILD_DIR)/auto_jekyll.ninja
+ASCIIDOC_INCLUDES_DIR = $(BUILD_DIR)/adoc_includes
 
 # The $(MARKER_FILE) is used to ensure that all the asciidoc files are copied before we try invoking jekyll
 all: | $(MARKER_FILE)
@@ -47,7 +48,7 @@ $(OUTPUT_DIR)/_includes/%.html: $(SCRIPTS_DIR)/fetch_header_and_fonts.py | $(OUT
 	$< https://esi.raspberrypi.org/en/components/$*/ $@
 
 $(AUTO_NINJABUILD): $(SCRIPTS_DIR)/create_jekyll_ninjabuild.py $(DOCUMENTATION_INDEX) | $(BUILD_DIR)
-	$< $(DOCUMENTATION_INDEX) $(SITE_CONFIG) $(ASCIIDOC_DIR) $(OUTPUT_DIR) $@
+	$< $(DOCUMENTATION_INDEX) $(SITE_CONFIG) $(ASCIIDOC_DIR) $(OUTPUT_DIR) $(ASCIIDOC_INCLUDES_DIR) $@
 
 $(OUTPUT_DIR)/_data/index.json: $(SCRIPTS_DIR)/create_output_index_json.py $(DOCUMENTATION_INDEX) | $(OUTPUT_DIR)/_data
 	$< $(DOCUMENTATION_INDEX) $@
diff --git a/makefiles/shared.ninja b/makefiles/shared.ninja
@@ -17,7 +17,7 @@ rule create_search
   command = $SCRIPTS_DIR/create_search.py $DOCUMENTATION_INDEX $src_dir $out
 
 rule create_build_adoc
-  command = $SCRIPTS_DIR/create_build_adoc.py $DOCUMENTATION_INDEX $SITE_CONFIG $GITHUB_EDIT_TEMPLATE $in $out_dir $out
+  command = $SCRIPTS_DIR/create_build_adoc.py $DOCUMENTATION_INDEX $SITE_CONFIG $GITHUB_EDIT_TEMPLATE $in $inc_dir $out
 
 rule create_build_adoc_include
   command = $SCRIPTS_DIR/create_build_adoc_include.py $SITE_CONFIG $GITHUB_EDIT_TEMPLATE $in $out
diff --git a/scripts/create_build_adoc.py b/scripts/create_build_adoc.py
@@ -11,7 +11,7 @@
     config_yaml = sys.argv[2]
     github_edit = sys.argv[3]
     src_adoc = sys.argv[4]
-    build_dir = sys.argv[5]
+    includes_dir = sys.argv[5]
     build_adoc = sys.argv[6]
     output_subdir = os.path.basename(os.path.dirname(build_adoc))
     adoc_filename = os.path.basename(build_adoc)
@@ -63,4 +63,4 @@
 :sectanchors:
 
 {}
-""".format(output_subdir, build_dir, '{} - {}'.format(site_config['title'], index_title), index_title, new_contents))
+""".format(output_subdir, includes_dir, '{} - {}'.format(site_config['title'], index_title), index_title, new_contents))
diff --git a/scripts/create_jekyll_ninjabuild.py b/scripts/create_jekyll_ninjabuild.py
@@ -38,7 +38,8 @@ def scan_adoc(adoc_filename, apparent_filename):
     if not os.path.exists(input_dir):
         raise Exception("Error: {} doesn't exist".format(input_dir))
     output_dir = sys.argv[4]
-    output_ninjabuild = sys.argv[5]
+    adoc_includes_dir = sys.argv[5]
+    output_ninjabuild = sys.argv[6]
 
     # Read _config.yml
     with open(config_yaml) as config_fh:
@@ -74,6 +75,7 @@ def scan_adoc(adoc_filename, apparent_filename):
         ninja.newline()
         ninja.variable('src_dir', input_dir)
         ninja.variable('out_dir', output_dir)
+        ninja.variable('inc_dir', adoc_includes_dir)
         ninja.newline()
         ninja.include('makefiles/shared.ninja')
         ninja.newline()
@@ -100,7 +102,7 @@ def scan_adoc(adoc_filename, apparent_filename):
         for page in sorted(doc_pages):
             if page in join_files:
                 for include in join_files[page]:
-                    dest = os.path.join('$out_dir', include)
+                    dest = os.path.join('$inc_dir', include)
                     source = os.path.join('$src_dir', include)
                     if source not in all_doc_sources:
                         scan_adoc(include, page)
