瀏覽代碼

Organize documentation source files

Ole 9 年之前
父節點
當前提交
94f597bee8
共有 7 個文件被更改,包括 36 次插入6 次删除
  1. 5 5
      Doxyfile
  2. 6 1
      Makefile
  3. 0 0
      docs/doxygen/footer.html
  4. 0 0
      docs/doxygen/header.html
  5. 0 0
      docs/doxygen/stylesheet.css
  6. 17 0
      docs/mkdocs/index.md
  7. 8 0
      mkdocs.yml

+ 5 - 5
Doxyfile

@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 # left blank the current directory will be used.
 
 
-OUTPUT_DIRECTORY       = docs/
+OUTPUT_DIRECTORY       = docs/output
 
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # 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
 # directories (in 2 levels) under the output directory of each output format and
@@ -1035,7 +1035,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 
-HTML_OUTPUT            = html
+HTML_OUTPUT            = reference
 
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).
 # generated HTML page (for example: .htm, .php, .asp).
@@ -1062,7 +1062,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 
-HTML_HEADER            = docs/header.html
+HTML_HEADER            = docs/doxygen/header.html
 
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1072,7 +1072,7 @@ HTML_HEADER            = docs/header.html
 # that doxygen normally uses.
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 
-HTML_FOOTER            = docs/footer.html
+HTML_FOOTER            = docs/doxygen/footer.html
 
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1097,7 +1097,7 @@ HTML_STYLESHEET        =
 # list). For an example see the documentation.
 # list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
 
-HTML_EXTRA_STYLESHEET  = docs/stylesheet.css
+HTML_EXTRA_STYLESHEET  = docs/doxygen/stylesheet.css
 
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
 # other source files which should be copied to the HTML output directory. Note

+ 6 - 1
Makefile

@@ -28,13 +28,18 @@ USECXXFLAGS     += $(CXXFLAGS) -std=c++11 -O0 -g -DDEBUG -fmessage-length=0 -Wal
 USELDFLAGS      += $(LDFLAGS) -L$(LUA_LIBDIR)
 USELDFLAGS      += $(LDFLAGS) -L$(LUA_LIBDIR)
 USELDLIBS       += $(LDLIBS) -lm -l$(LUA_LIBNAME) -ldl
 USELDLIBS       += $(LDLIBS) -lm -l$(LUA_LIBNAME) -ldl
 
 
+# Miscellaneous
+DOCS_OUT        := docs/output
+
 # Default targets
 # Default targets
 all: test examples
 all: test examples
 
 
 clean:
 clean:
-	$(RM) $(EXAMPLE_OBJS) $(EXAMPLE_DEPS) $(TEST_OUT) $(TEST_OBJS) $(TEST_DEPS)
+	$(RM) $(EXAMPLE_OBJS) $(EXAMPLE_DEPS) $(TEST_OUT) $(TEST_OBJS) $(TEST_DEPS) $(DOCS_OUT)
 
 
+# Documentation
 docs:
 docs:
+	mkdocs build
 	doxygen
 	doxygen
 
 
 # Tests
 # Tests

+ 0 - 0
docs/footer.html → docs/doxygen/footer.html


+ 0 - 0
docs/header.html → docs/doxygen/header.html


+ 0 - 0
docs/stylesheet.css → docs/doxygen/stylesheet.css


+ 17 - 0
docs/mkdocs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](http://mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs help` - Print this help message.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

+ 8 - 0
mkdocs.yml

@@ -0,0 +1,8 @@
+site_name: Luwra
+site_description: Minimal-overhead Lua wrapper for C++
+repo_url: https://github.com/vapourismo/luwra
+pages:
+  - 'Home': index.md
+theme: readthedocs
+docs_dir: docs/mkdocs
+site_dir: docs/output