Skip to content

Commit

Permalink
Faster changes for local testing
Browse files Browse the repository at this point in the history
Signed-off-by: Sara Damiano <[email protected]>
  • Loading branch information
SRGDamia1 committed Aug 14, 2024
1 parent c5b285c commit 0fadda7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
20 changes: 12 additions & 8 deletions docs/markdown_prefilter.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ def github_slugify(name):
in_fence = False
fence_language = ""
i = 1
local_testing = False

# when testing use:
# with fileinput.FileInput(
# "C:\\Users\\sdamiano\\Documents\\GitHub\\EnviroDIY\\Arduino-SDI-12\\docs\\CreatingACharacter.md",
# "C:\\Users\\sdamiano\\Documents\\GitHub\\EnviroDIY\\Arduino-SDI-12\\ChangeLog.md",
# openhook=fileinput.hook_encoded("utf-8", "surrogateescape"),
# ) as input:

Expand All @@ -64,22 +65,25 @@ def github_slugify(name):
seper = "\\"
else:
seper = "/"
# print("Separator: '{}'\n".format(seper))
if local_testing:
print("Separator: '{}'\n".format(seper))
file_dir = file_name_dir.rsplit(sep=seper, maxsplit=1)[0]
file_name_ext = file_name_dir.rsplit(sep=seper, maxsplit=1)[1]
file_name = file_name_ext.rsplit(sep=".", maxsplit=1)[0]
file_ext = file_name_ext.rsplit(sep=".", maxsplit=1)[1]
# print(
# "File Directory: {}, File Name: {}, File Extension: {}\n".format(
# file_dir, file_name, file_ext
# )
# )
if local_testing:
print(
"File Directory: {}, File Name: {}, File Extension: {}\n".format(
file_dir, file_name, file_ext
)
)
# For the example walk-throughs, written in the ReadMe files,
# we want the example name, which is part of the directory.
if "examples" in file_dir and file_name == "ReadMe":
file_name = "example_" + file_dir.rsplit(sep=seper, maxsplit=1)[-1]

# print(i, print_me, skip_me, in_fence, fence_language, line)
if local_testing:
print(i, print_me, skip_me, in_fence, fence_language, line)

# I'm using these comments to fence off content that is only intended for
# github mardown rendering
Expand Down
2 changes: 1 addition & 1 deletion docs/runDoxygen.bat
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ set PLATFORMIO_GLOBALLIB_DIR=../.pio/libdeps/mayfly
set PLATFORMIO_PACKAGES_DIR=C:/Users/sdamiano/.platformio/PLATFORMIO_PACKAGES_DIR

echo Generating Doxygen code documentation...
"C:\Program Files\doxygen\bin\doxygen.exe" Doxyfile > output_doxygen_run.log 2>&1
"C:\Program Files\doxygen\bin\doxygen.exe" -d filteroutput -d commentcnv -d markdown Doxyfile > output_doxygen_run.log 2>&1
endlocal

@REM Fix up xml sections before running m.css
Expand Down

0 comments on commit 0fadda7

Please sign in to comment.