Skip to content

Commit f76efab

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 f76efab

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+3
-7443
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ production release here:
7777
The follow described the major aspects of the project structure:
7878

7979
- `azure-pipelines/` - CI configuration files for Azure Pipelines.
80-
- `docs/api` - Interface definition and usage documentation.
8180
- `src/mbed_tools/` - Python source files.
8281
- `news/` - Collection of news files for unreleased changes.
8382
- `tests/` - Unit and integration tests.

azure-pipelines/analyse-and-test.yml

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
# This pipeline performs multiple actions to ensure the quality of the package:
44
# - Performs static analysis and runs test on multiple Python versions and host platforms.
55
# - Uploads test coverage to Code Climate
6-
# - Generates reference documentation
76

87
# Trigger on a PR to master, beta or releases branches.
98
pr:
@@ -112,27 +111,3 @@ stages:
112111
displayName: run tox -e $(tox.env)
113112
114113
- template: steps/publish-code-coverage-results.yml
115-
116-
- stage: DocBuild
117-
displayName: 'Build Documentation'
118-
dependsOn: []
119-
jobs:
120-
- job: Docs
121-
displayName: 'Build Documentation'
122-
pool:
123-
vmImage: 'ubuntu-latest'
124-
125-
steps:
126-
- task: UsePythonVersion@0
127-
displayName: 'Use Python 3.7'
128-
inputs:
129-
versionSpec: '3.7'
130-
131-
- script: |
132-
python -m pip install --upgrade tox
133-
tox -e generatedocs -- $(Build.Repository.LocalPath)/docs/api
134-
displayName: run tox -e generatedocs -- $(Build.Repository.LocalPath)/docs/api
135-
136-
- publish: $(Build.Repository.LocalPath)/docs/api
137-
artifact: Documentation
138-
displayName: 'Publish documentation'

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)