diff options
| author | kat <kat@vector35.com> | 2023-01-24 15:24:33 -0500 |
|---|---|---|
| committer | kat <kat@vector35.com> | 2023-01-24 15:24:37 -0500 |
| commit | e1c7fd0ba21cdb887c97db76aa0600e264e66503 (patch) | |
| tree | a8869c92f4ec4f74059c0ec0df99489b25b8dabc /api-docs | |
| parent | 53ab17fbf4f5210fece91d601b15cab069fbb41f (diff) | |
Attempt to prevent bad C++ docs from being shipped again
Diffstat (limited to 'api-docs')
| -rw-r--r-- | api-docs/cppdocs/USEBUILDMINDOCS (renamed from api-docs/cppdocs/Doxyfile) | 0 | ||||
| -rw-r--r-- | api-docs/cppdocs/build_min_docs.py | 7 |
2 files changed, 5 insertions, 2 deletions
diff --git a/api-docs/cppdocs/Doxyfile b/api-docs/cppdocs/USEBUILDMINDOCS index 9c33604c..9c33604c 100644 --- a/api-docs/cppdocs/Doxyfile +++ b/api-docs/cppdocs/USEBUILDMINDOCS diff --git a/api-docs/cppdocs/build_min_docs.py b/api-docs/cppdocs/build_min_docs.py index 455c1376..92fde5fc 100644 --- a/api-docs/cppdocs/build_min_docs.py +++ b/api-docs/cppdocs/build_min_docs.py @@ -126,14 +126,17 @@ def minifier(): def build_doxygen(): - if not os.path.exists('./Doxyfile'): + if not os.path.exists('./USEBUILDMINDOCS'): print('No Doxyfile found. Are you in the right directory?') sys.exit(1) _, vers, _ = system_with_output("doxygen -V") if __DOXYGEN_REQUIRED_VERSION__ not in vers.strip(): print(f'Please use Doxygen {__DOXYGEN_REQUIRED_VERSION__} to build documentation') + print(f'Please use Doxygen {__DOXYGEN_REQUIRED_VERSION__} to build documentation') sys.exit(1) + print(f'DOXYGEN VERSION: {vers.strip()}') + if os.path.exists('./html/'): print('Clearing ./html/') try: @@ -142,7 +145,7 @@ def build_doxygen(): # doing it twice works (on macOS) ¯\_(ツ)_/¯ shutil.rmtree("./html/") print(f'Building doxygen docs...') - stat, out, err = system_with_output("doxygen Doxyfile") + stat, out, err = system_with_output("doxygen USEBUILDMINDOCS") print(f"Built Doxygen with status code {stat}") print("Output dir is ./html/") |