Skip to content

Commit 4c9e9b5

Browse files
authored
Integrate HTML stripping into doc-builder (#684)
* Integrate HTML stripping into doc-builder - Add HTML stripping functions to src/doc_builder/utils.py - Strip HTML when writing final markdown files (in write_markdown_route_file) - Add standalone script src/scripts/strip_html_from_md.py for manual use - Add README_strip_html.md with documentation HTML stripping now happens automatically during the build process when creating SvelteKit markdown routes (+page.md files), removing docstring HTML tags and converting them to clean markdown with proper formatting. * Remove HTML stripping workflow steps HTML stripping is now integrated into the build process itself (in write_markdown_route_file), so separate workflow steps are not needed. * Remove standalone script and README HTML stripping is now fully integrated into doc_builder/utils.py, so the standalone script and its documentation are no longer needed.
1 parent aff17e5 commit 4c9e9b5

File tree

5 files changed

+261
-457
lines changed

5 files changed

+261
-457
lines changed

.github/workflows/build_main_documentation.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -234,13 +234,6 @@ jobs:
234234
235235
cd ..
236236
237-
- name: Strip HTML from built markdown files
238-
run: |
239-
source .venv/bin/activate
240-
echo "Stripping HTML from markdown files in build_dir"
241-
python3 doc-builder/src/scripts/strip_html_from_md.py build_dir/ --recursive
242-
echo "HTML stripping complete"
243-
244237
- name: Push to repositories
245238
run: |
246239
source .venv/bin/activate

.github/workflows/build_pr_documentation.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -219,13 +219,6 @@ jobs:
219219
fi
220220
cd ..
221221
222-
- name: Strip HTML from built markdown files
223-
run: |
224-
source .venv/bin/activate
225-
echo "Stripping HTML from markdown files in build_dir"
226-
python3 doc-builder/src/scripts/strip_html_from_md.py build_dir/ --recursive
227-
echo "HTML stripping complete"
228-
229222
- name: Save commit_sha & pr_number
230223
run: |
231224
echo ${{ inputs.commit_sha }} > ./build_dir/commit_sha

README_strip_html.md

Lines changed: 0 additions & 99 deletions
This file was deleted.

0 commit comments

Comments
 (0)