diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | docs/index.md | 2 | ||||
| -rwxr-xr-x | scripts/build_docs.sh | 3 |
4 files changed, 10 insertions, 2 deletions
@@ -70,7 +70,8 @@ MANIFEST-* docs/_site docs/gathered _site -doxygen/ +doxygen +docs/dev # Sublime Text settings *.sublime-workspace @@ -191,7 +191,8 @@ ALL_BUILD_DIRS := $(sort \ # Set directory for Doxygen-generated documentation ############################## DOXYGEN_CONFIG_FILE ?= ./.Doxyfile -DOXYGEN_OUTPUT_DIR ?= ./doxygen # should be the same as OUTPUT_DIRECTORY in the .Doxyfile +# should be the same as OUTPUT_DIRECTORY in the .Doxyfile +DOXYGEN_OUTPUT_DIR ?= ./doxygen DOXYGEN_COMMAND ?= doxygen # All the files that might have Doxygen documentation. DOXYGEN_SOURCES := $(shell find \ @@ -337,6 +338,7 @@ lintclean: @ $(RM) -r $(LINT_OUTPUT_DIR) $(EMPTY_LINT_REPORT) $(NONEMPTY_LINT_REPORT) docs: $(DOXYGEN_OUTPUT_DIR) + @ cd ./docs ; ln -sfn ../$(DOXYGEN_OUTPUT_DIR)/html doxygen $(DOXYGEN_OUTPUT_DIR): $(DOXYGEN_CONFIG_FILE) $(DOXYGEN_SOURCES) $(DOXYGEN_COMMAND) $(DOXYGEN_CONFIG_FILE) diff --git a/docs/index.md b/docs/index.md index 67b424ce..94227c25 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,6 +43,8 @@ Tested on Ubuntu, Red Hat, OS X. BVLC provides ready-to-use models for non-commercial use. * [Developing & Contributing](/development.html)<br /> Guidelines for development and contributing to Caffe. +* [API Documentation](/doxygen/)<br /> +Developer documentation automagically generated from code comments. ### Examples diff --git a/scripts/build_docs.sh b/scripts/build_docs.sh index c5680151..f8ace0ea 100755 --- a/scripts/build_docs.sh +++ b/scripts/build_docs.sh @@ -12,6 +12,9 @@ cd $ROOT_DIR # Gather docs. scripts/gather_examples.sh +# Generate developer docs. +make docs + # Display docs using web server. cd docs jekyll serve -w -s . -d _site --port=$PORT |