Skip to content

Commit

Permalink
[DOC] Fix doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
tqchen committed May 8, 2016
1 parent 76767aa commit 49e470e
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ lint: rcpplint jnilint
doc: doxygen

doxygen:
doxygen doc/Doxyfile
doxygen docs/Doxyfile

# R related shortcuts
rcpplint:
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
_build/*
*.pyc
doxygen
2 changes: 1 addition & 1 deletion doc/Doxyfile → docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = doc/doxygen
OUTPUT_DIRECTORY = docs/doxygen

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
Expand Down
5 changes: 1 addition & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.ifconfig']

# breathe_default_project = "format"
#breathe_domain_by_extension = {"h" : "cpp"}


# General information about the project.
project = u'mxnet'
author = u'%s developers' % project
Expand Down Expand Up @@ -301,6 +297,7 @@ def run_doxygen(folder):
"""Run the doxygen make command in the designated folder."""
try:
retcode = subprocess.call("cd %s; make doxygen" % folder, shell=True)
retcode = subprocess.call("cp -rf doxygen/html _build/html/doxygen", shell=True)
if retcode < 0:
sys.stderr.write("doxygen terminated by signal %s" % (-retcode))
except OSError as e:
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/new_op.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ extern "C" __global__ mykernel(float *x, float *y) {
Finally, we launch the kernel with `self.fwd_kernel.push([x], [y], (1, 1, 1), (x.shape[0], 1, 1))`, where `(1, 1, 1)` and `(x.shape[0], 1, 1)` are the grid and block dimensions.
## C++/MShadow(CUDA)
Please refer to [Developer Guide - Operators](https://mxnet.readthedocs.org/en/latest/developer-guide/operator.html) for detail.
Please refer to [Developer Guide - Operators](https://mxnet.readthedocs.org/en/latest/system/operator.html) for detail.

0 comments on commit 49e470e

Please sign in to comment.