Skip to content
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

Merged
merged 2 commits into from Aug 21, 2019

Conversation

KSerrania
Copy link
Contributor

@KSerrania KSerrania commented Aug 13, 2019

What does this PR do?

Add a CircleCI job which generates the rtloader documentation to check that there are no errors.

Motivation

rtloader documentation.

@KSerrania KSerrania added changelog/no-changelog [deprecated] team/agent-core Deprecated. Use metrics-logs / shared-components labels instead.. labels Aug 13, 2019
@KSerrania KSerrania added this to the 6.14.0 milestone Aug 13, 2019
@KSerrania KSerrania marked this pull request as ready for review August 13, 2019 13:07
Copy link
Member

@olivielpeau olivielpeau left a 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
Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@KSerrania KSerrania merged commit b80dd3e into master Aug 21, 2019
@KSerrania KSerrania deleted the kserrania/add-doxygen-check-in-ci branch August 21, 2019 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog [deprecated] team/agent-core Deprecated. Use metrics-logs / shared-components labels instead..
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants