summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 09a1ce7)
raw | patch | inline | side by side (parent: 09a1ce7)
author | Evan Shelhamer <shelhamer@imaginarynumber.net> | |
Wed, 3 Sep 2014 20:22:09 +0000 (13:22 -0700) | ||
committer | Evan Shelhamer <shelhamer@imaginarynumber.net> | |
Wed, 3 Sep 2014 20:25:46 +0000 (13:25 -0700) |
.gitignore | patch | blob | history | |
Makefile | patch | blob | history | |
docs/index.md | patch | blob | history | |
scripts/build_docs.sh | patch | blob | history |
diff --git a/.gitignore b/.gitignore
index 9ba6de74561eed98f685a5398433416288010a62..2ac7a0096ebb323ea8af3413bdc3c533b9d9d89b 100644 (file)
--- a/.gitignore
+++ b/.gitignore
docs/_site
docs/gathered
_site
-doxygen/
+doxygen
+docs/dev
# Sublime Text settings
*.sublime-workspace
diff --git a/Makefile b/Makefile
index 50e68acd84cbf7415a3a1c2d1b052b6b42ae0f84..546de931f7e552b323b0df18dc8daed8efab6090 100644 (file)
--- a/Makefile
+++ b/Makefile
# 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 \
@ $(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 67b424ceefd25da9687b7ef7301dd6808efe181e..94227c25249740f250729bf9303db0c65858c608 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
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 c5680151416b3500da0a6044b87a813965e4d140..f8ace0ead4374007424c5997001ce9cfc407bfbe 100755 (executable)
--- a/scripts/build_docs.sh
+++ b/scripts/build_docs.sh
# 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