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.
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
[CircleCI] Add doxygen doc generation step #4011
Conversation
ada13e9
to
628a114
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one question, LGTM in any case
@@ -7,7 +7,8 @@ RUN set -ex \ | |||
gcc g++ make git ssh curl pkg-config file \ | |||
python-dev python-setuptools python-pip \ | |||
python3.7-dev python3-distutils python3-pip python3-yaml \ | |||
libssl-dev libsnmp-base libsnmp-dev libpq-dev snmp-mibs-downloader libsystemd-dev | |||
libssl-dev libsnmp-base libsnmp-dev libpq-dev snmp-mibs-downloader libsystemd-dev \ | |||
doxygen graphviz |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is graphviz also needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dot
(included in the graphviz
package) is needed to draw the class & dependency graphs on each page of the documentation. It's not strictly required (the doxygen
command will still complete), but not adding it will make doxygen output a bunch of error / warning messages because of dot
not being available.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
What does this PR do?
Add a CircleCI job which generates the
rtloader
documentation to check that there are no errors.Motivation
rtloader
documentation.