Merge pull request #21 from servo/rustdoc

Generate documentation with rustdoc
servo · Aug 4, 2014 · 7491a23 · 7491a23
2 parents ac87a88 + aa718dc
commit 7491a23
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-*~
+*~
+/doc
diff --git a/Makefile.in b/Makefile.in
@@ -2,6 +2,9 @@ VPATH=%VPATH%
 
 RUSTC ?= rustc
 RUSTFLAGS ?=
+RUSTDOC ?= rustdoc
+RUSTDOC_FLAGS ?=
+RUSTDOC_TARGET ?= doc
 
 RUST_SRC=$(shell find $(VPATH)/. -type f -name '*.rs')
 
@@ -19,6 +22,12 @@ xlib-test: lib.rs $(RUST_SRC)
 check: xlib-test
 	./xlib-test $(TEST)
 
+.PHONY: doc
+doc: $(RUSTDOC_TARGET)/xlib/index.html
+
+$(RUSTDOC_TARGET)/xlib/index.html: lib.rs $(RUST_SRC)
+	$(RUSTDOC) $(RUSTDOC_FLAGS) $< -o $(RUSTDOC_TARGET)
+
 .PHONY: clean
 clean:
 	rm -f *.o *.a *.so *.dylib *.rlib *.dll *.dummy *-test
-Original file line number
+Diff line change
@@ -1 +1,2 @@
-    *~
+    *~
+    /doc