Skip to content

Commit

Permalink
DOC: Convert from raw in-code citations to bibtex (1/N)
Browse files Browse the repository at this point in the history
First PR out of N, converting raw inline citations with various styles to
using a bibliography database and the doxygen cite command.

Bibtex file was formatted using bibtex-tidy
(https://github.com/FlamingTempura/bibtex-tidy). This tool can be used
as a pre-commit hook but currently does not have an option for just
performing compliance checking so not added to .pre-commit-config.yaml
file.
  • Loading branch information
zivy authored and dzenanz committed Jan 31, 2025
1 parent 1a25ac2 commit 097e2dc
Show file tree
Hide file tree
Showing 141 changed files with 1,307 additions and 720 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/spell-check-comments.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install comment-spell-check~=0.2.2
python -m pip install comment-spell-check~=0.3.0
curl -O https://raw.githubusercontent.com/SimpleITK/SimpleITK/master/.github/workflows/additional_dictionary.txt
- name: Spell check Modules directory
Expand All @@ -29,6 +29,7 @@ jobs:
--miss \
--prefix "gdcm" --exclude ThirdParty \
--dict additional_dictionary.txt \
--bibtex Documentation/Doxygen/doxygen.bib \
--dict .github/workflows/itk_dict.txt \
--suffix ".h" \
--suffix ".hxx" \
Expand Down
Loading

0 comments on commit 097e2dc

Please sign in to comment.