Skip to content

Separate spellcheck failure from docs build in CI #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BrianSipos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Separate spellcheck failure from docs build in CI #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ jobs:
-DBUILD_DOCS_API=ON
- name: Build
run: ./build.sh --target docs-api-html docs-api-pdf docs-api-misspelling
- name: Misspelling
env:
MISSPELLING_TXT: 'build/default/docs/api/misspelling.txt'
# success means file is present and empty
run: test -f "${MISSPELLING_TXT}" -a ! -s "${MISSPELLING_TXT}" || (cat "${MISSPELLING_TXT}"; exit 1)
- name: Install
run: ./build.sh install --component docs-api
- name: Compress
Expand Down
6 changes: 0 additions & 6 deletions docs/api/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ the prime contract 80NM0018D0004 between the Caltech and NASA under
subcontract 1700763.
]]

include(GNUInstallDirs)

find_package(Doxygen REQUIRED)

find_program(XMLSTARLET_EXECUTABLE xmlstarlet)
Expand Down Expand Up @@ -97,10 +95,6 @@ if(XMLSTARLET_EXECUTABLE AND ASPELL_EXECUTABLE)
add_custom_target(
docs-api-misspelling
DEPENDS "${MISSPELLING_TXT}"
COMMAND cat "${MISSPELLING_TXT}"
# success means file is present and empty
COMMAND test -f "${MISSPELLING_TXT}" -a ! -s "${MISSPELLING_TXT}"
COMMENT "Checking ${MISSPELLING_TXT}"
)
endif(XMLSTARLET_EXECUTABLE AND ASPELL_EXECUTABLE)

Expand Down
Loading