diff options
| author | Peter Goldsborough <psag@fb.com> | 2018-09-05 10:17:33 -0700 |
|---|---|---|
| committer | Facebook Github Bot <facebook-github-bot@users.noreply.github.com> | 2018-09-05 10:25:56 -0700 |
| commit | e6d6aed12e5c4fb1880348e7ddbbecd6d8068604 (patch) | |
| tree | 7cd5f446404eee186e03e39c492e16837f3a8288 /.travis.yml | |
| parent | 267e1ec112b34bdb925c78fd399ef049f66777d6 (diff) | |
| download | pytorch-e6d6aed12e5c4fb1880348e7ddbbecd6d8068604.tar.gz pytorch-e6d6aed12e5c4fb1880348e7ddbbecd6d8068604.tar.bz2 pytorch-e6d6aed12e5c4fb1880348e7ddbbecd6d8068604.zip | |
Check doxygen output in travis (#11124)
Summary:
This PR adds a .travis.yml check for our C++ documentation. The goal is to avoid any documentation/comments in our C++ code that would break the doxygen output and possibly ruin the C++ documentation site (currently https://pytorch.org/cppdocs).
For this, we:
1. Run doxygen and record any warnings,
2. Filter out some known bogus warnings,
3. Count the remaining warnings,
4. Fail the check if (3) is non-zero.
soumith
Pull Request resolved: https://github.com/pytorch/pytorch/pull/11124
Differential Revision: D9651011
Pulled By: goldsborough
fbshipit-source-id: 30f776d23bb6d6c482c54db32828b4b99547e87b
Diffstat (limited to '.travis.yml')
| -rw-r--r-- | .travis.yml | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/.travis.yml b/.travis.yml index bd6cec56fb..be45e69f67 100644 --- a/.travis.yml +++ b/.travis.yml @@ -26,3 +26,6 @@ matrix: python: "3.6" install: pip install mypy mypy-extensions script: mypy @mypy-files.txt + - env: CPP_DOC_CHECK + install: sudo apt-get install -y doxygen + script: cd docs/cpp && ./check-doxygen.sh |