pytorch/docs/cpp
Peter Goldsborough e6d6aed12e 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
2018-09-05 10:25:56 -07:00
..
building.rst Basic infrastructure for C++ documentation (#10569) 2018-08-17 15:39:50 -07:00
check-doxygen.sh Check doxygen output in travis (#11124) 2018-09-05 10:25:56 -07:00
conf.py Basic infrastructure for C++ documentation (#10569) 2018-08-17 15:39:50 -07:00
contributing.rst Basic infrastructure for C++ documentation (#10569) 2018-08-17 15:39:50 -07:00
Doxyfile Check doxygen output in travis (#11124) 2018-09-05 10:25:56 -07:00
examples.rst Basic infrastructure for C++ documentation (#10569) 2018-08-17 15:39:50 -07:00
index.rst Basic infrastructure for C++ documentation (#10569) 2018-08-17 15:39:50 -07:00
Makefile Basic infrastructure for C++ documentation (#10569) 2018-08-17 15:39:50 -07:00
requirements.txt Basic infrastructure for C++ documentation (#10569) 2018-08-17 15:39:50 -07:00