Skip to content

Commit

Permalink
Add header comment for make_md.py
Browse files Browse the repository at this point in the history
  • Loading branch information
mmore500 committed Dec 7, 2023
1 parent 69a2b9b commit ac4b72e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions doc/make_md.py
Original file line number Diff line number Diff line change
@@ -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."""
Expand Down

0 comments on commit ac4b72e

Please sign in to comment.