Skip to content

Commit 58394e7

Browse files
committed
Remove pdoc3 documentation
We don't want to use this tool or the documentation generated by it, due to its use of controversial imagery in the auto generated HTML.
1 parent 73aac95 commit 58394e7

39 files changed

+3
-7410
lines changed

ci_scripts/prep-release

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,8 @@ python ci_scripts/sync_board_database.py -vvv
1010
git add src/mbed_tools/targets/_internal/data/board_database_snapshot.json
1111
git add news/
1212

13-
printf "Generating API docs and adding license headers\n"
14-
generate-docs --output_dir docs/api
13+
printf "Adding license headers\n"
1514
pre-commit run licenseheaders --all-files > /dev/null 2>&1 || true
16-
git add docs/api
1715

1816
if ! NEW_VERSION=$(python ci_scripts/bump_version.py -vvv -n news/); then
1917
printf "No news files detected. Exiting.\n"
@@ -25,7 +23,7 @@ git update-index -q --ignore-submodules --refresh
2523

2624
if ! git diff-index --cached --quiet HEAD --ignore-submodules --
2725
then
28-
printf "Found staged changes to commit after docs and target database update: $(git diff-index --cached --name-status --ignore-submodules HEAD)\n"
26+
printf "Found staged changes to commit after target database update: $(git diff-index --cached --name-status --ignore-submodules HEAD)\n"
2927
# Towncrier will fail if it detects a news file that has not been committed to
3028
# the repository. So we need to ensure the news file generated by
3129
# sync_board_database.py was committed before running towncrier.

docs/api/build/build.html

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

0 commit comments

Comments
 (0)