Clean up documentation.

morganbengtsson · Jun 17, 2020 · dd63fdb · dd63fdb
1 parent 9cbfd3c
commit dd63fdb
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 50 deletions.
diff --git a/doc/config.doxy b/doc/config.doxy
@@ -654,7 +654,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../include ../README.md
+INPUT                  = index.doc ../include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -779,7 +779,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = README.md
+USE_MDFILE_AS_MAINPAGE = NO
 
 #---------------------------------------------------------------------------
 # configuration options related to source browsing

diff --git a/doc/index.doc b/doc/index.doc
@@ -0,0 +1,7 @@
+/*! 
+
+\mainpage 
+
+API documentation for the <a href = "https://github.com/morganbengtsson/mos">MOS game engine</a>.
+
+*/
diff --git a/doc/source/conf.py b/doc/source/conf.py
diff --git a/doc/source/index.rst b/doc/source/index.rst