diff doc/mkdocs.yml @ 239:d47e70da760e

doc: switch to mkdocs+doxybook2, closes #2516 @2h
author David Demelier <markand@malikania.fr>
date Fri, 27 Nov 2020 17:00:30 +0100
parents
children 97f55f6b9593
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/mkdocs.yml	Fri Nov 27 17:00:30 2020 +0100
@@ -0,0 +1,45 @@
+#
+# mkdocs.yml.txt -- documentation for Molko's Adventure
+#
+# Copyright (c) 2020 David Demelier <markand@malikania.fr>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+site_name: Molko's Adventure
+theme: material
+markdown_extensions:
+  - admonition
+  - tables
+  - def_list
+nav:
+  - Home: index.md
+  - About: about.md
+  - Installation: install.md
+  - Specifications:
+    - map: specs/map.md
+    - tileset: specs/tileset.md
+  - Tools:
+    - mlk-bcc: tools/bcc.md
+    - mlk-map: tools/map.md
+    - mlk-tileset: tools/tileset.md
+  - Developer corner:
+    - Notes:
+      - Error handling: dev/error.md
+      - Ownership: dev/ownership.md
+      - FAQ: dev/faq.md
+    - Howto:
+      - dev/howto/01-init.md
+    - API Reference:
+      - Modules: modules/index.md
+      - Files: files/index.md