From dd63fdbdd085cf6a0ed63c66329aa9c039d2c1e4 Mon Sep 17 00:00:00 2001 From: Morgan Bengtsson Date: Wed, 17 Jun 2020 13:56:46 +0200 Subject: [PATCH] Clean up documentation. --- doc/config.doxy | 4 ++-- doc/index.doc | 7 +++++++ doc/source/conf.py | 47 -------------------------------------------- doc/source/index.rst | 1 - 4 files changed, 9 insertions(+), 50 deletions(-) create mode 100644 doc/index.doc delete mode 100644 doc/source/conf.py delete mode 100644 doc/source/index.rst diff --git a/doc/config.doxy b/doc/config.doxy index 25ac13ea..d292a98c 100644 --- 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 new file mode 100644 index 00000000..3f48b69d --- /dev/null +++ b/doc/index.doc @@ -0,0 +1,7 @@ +/*! + +\mainpage + +API documentation for the MOS game engine. + +*/ diff --git a/doc/source/conf.py b/doc/source/conf.py deleted file mode 100644 index 36f99d17..00000000 --- a/doc/source/conf.py +++ /dev/null @@ -1,47 +0,0 @@ -import sys -import os -import subprocess - -#Read the docs -read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' -#if read_the_docs_build: -subprocess.call('cd ../; doxygen config.doxy', shell=True) - -# -- General configuration ------------------------------------------------ - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'MOS' -copyright = '2015, Morgan Bengtsson' - -version = '1.0.0' -# The full version, including alpha/beta/rc tags. -release = '1.0.0' - -exclude_patterns = [] - -pygments_style = 'sphinx' - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Output file base name for HTML help builder. -htmlhelp_basename = 'MOSdoc' - -html_extra_path = ['../build/html'] diff --git a/doc/source/index.rst b/doc/source/index.rst deleted file mode 100644 index f98b5be6..00000000 --- a/doc/source/index.rst +++ /dev/null @@ -1 +0,0 @@ -Temp \ No newline at end of file