Include a documentation index
authorJeremy Stanley <fungi@yuggoth.org>
Mon, 30 Apr 2018 19:37:45 +0000 (19:37 +0000)
committerJeremy Stanley <fungi@yuggoth.org>
Mon, 30 Apr 2018 19:37:45 +0000 (19:37 +0000)
A documentation index page with the project's README text
transcluded, so that it can also serve as the main page for a new
mudpy Web site.

doc/source/index.rst [new file with mode: 0644]

diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644 (file)
index 0000000..3b219d5
--- /dev/null
@@ -0,0 +1,29 @@
+.. Copyright (c) 2018 Jeremy Stanley <fungi@yuggoth.org>.
+   Permission to use, copy, modify, and distribute this software is
+   granted under terms provided in the LICENSE file distributed with
+   this software.
+
+.. title:: about
+.. meta::
+   :description: The mudpy MUD server engine.
+   :keywords: Multi-User Dungeon, MUD, Role-Playing, Game, Telnet,
+              Text, Python, Free Software, Open Source, Libre, FLOSS
+
+.. include:: ../../README
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :numbered:
+
+   api
+   changelog
+   clients
+   coder
+   configuration
+   data_model
+   license
+
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`