From 49e470efd362e06e163902721d6077cebe59426b Mon Sep 17 00:00:00 2001 From: tqchen Date: Sat, 7 May 2016 20:56:04 -0700 Subject: [PATCH] [DOC] Fix doxygen --- Makefile | 2 +- docs/.gitignore | 1 + {doc => docs}/Doxyfile | 2 +- docs/conf.py | 5 +---- docs/how_to/new_op.md | 2 +- 5 files changed, 5 insertions(+), 7 deletions(-) rename {doc => docs}/Doxyfile (99%) diff --git a/Makefile b/Makefile index 822f3167fa13..788d25a7d186 100644 --- a/Makefile +++ b/Makefile @@ -213,7 +213,7 @@ lint: rcpplint jnilint doc: doxygen doxygen: - doxygen doc/Doxyfile + doxygen docs/Doxyfile # R related shortcuts rcpplint: diff --git a/docs/.gitignore b/docs/.gitignore index 858abd0d4f46..4cc031f441e0 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,3 @@ _build/* *.pyc +doxygen diff --git a/doc/Doxyfile b/docs/Doxyfile similarity index 99% rename from doc/Doxyfile rename to docs/Doxyfile index 59d6c903986c..4421409de733 100644 --- a/doc/Doxyfile +++ b/docs/Doxyfile @@ -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 diff --git a/docs/conf.py b/docs/conf.py index a49172bbc26c..2a3acbfe8b0c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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: diff --git a/docs/how_to/new_op.md b/docs/how_to/new_op.md index 9c37b87e8d45..688ad234f8c9 100644 --- a/docs/how_to/new_op.md +++ b/docs/how_to/new_op.md @@ -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.