From ac4b72e9099363696e0d18501cb57e755768f205 Mon Sep 17 00:00:00 2001 From: Matthew Andres Moreno Date: Thu, 7 Dec 2023 17:42:51 -0500 Subject: [PATCH] Add header comment for make_md.py --- doc/make_md.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/make_md.py b/doc/make_md.py index fb58752d16..4d628bdbbb 100644 --- a/doc/make_md.py +++ b/doc/make_md.py @@ -1,6 +1,17 @@ import glob import os +# This script performs preprocessing for the Empirical documentation +# build process, manually filling in the folder tree `library` with stub +# markdown files for the documentation of Empirical header files to be built +# onto. +# +# The script scans the "../include/emp" directory for all ".hpp" files (with +# several explicit exclusions). For each header `emp/subname/filename.hpp` +# it creates a stub `library/subname/api/file.md`. Note that the `library` +# folder already contains skeleton content (i.e., stub pages for each of +# Emprical's subdirectories. Note also that some Empirical subdirectories +# not intended for external use are explicitly excluded. def format_directive(filename): """Create the breathe directive and add the options."""