This repository was archived by the owner on Nov 17, 2023. It is now read-only.
build docs with CPP package#13983
Merged
Merged
Conversation
marcoabreu
reviewed
Jan 25, 2019
| app.builder.srcdir) | ||
| else: | ||
| _run_cmd("cd %s/.. && make -j$(nproc) DEBUG=1 USE_MKLDNN=0" % | ||
| _run_cmd("cd %s/.. && make -j$(nproc) DEBUG=1 USE_MKLDNN=0 USE_CPP_PACKAGE=1" % |
Contributor
There was a problem hiding this comment.
Do we need to build with DEBUG=1 if we're only interested in documentation?
Contributor
Author
There was a problem hiding this comment.
It's always been there. Not sure of the impact of removing it. Maybe I can test it out and remove it in another PR.
Contributor
There was a problem hiding this comment.
I remember that I added the DEBUG flag quite some time ago, but that was to build with debug symbols. Probably some copy&paste leftover. It doubles the buildtime though if I remember correctly
marcoabreu
approved these changes
Jan 26, 2019
jlcontreras
pushed a commit
to jlcontreras/incubator-mxnet
that referenced
this pull request
Feb 14, 2019
stephenrawls
pushed a commit
to stephenrawls/incubator-mxnet
that referenced
this pull request
Feb 16, 2019
haohuanw
pushed a commit
to haohuanw/incubator-mxnet
that referenced
this pull request
Jun 23, 2019
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #13920
This PR will generate docs for the functions in
op.hwhich is created only if you build MXNet withUSE_CPP_PACKAGE=1.Comments
This generates a lot of warnings, but C++ pipeline hasn't been cleaned up yet anyway, so it's not a big deal at the moment. Having the APIs documented is more important than getting a bunch of warnings. That being said, it would be great if someone familiar with the C++ code can figure out why Doxygen is not happy with the
op.h's docstrings.Preview
http://34.201.8.176/versions/c_op/doxygen/op_8h.html