diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 5eee67f..222ebba 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -7,4 +7,46 @@ breathe_projects = {} if read_the_docs_build: subprocess.call('cd .. ; doxygen', shell=True) breathe_projects['knx'] = '../build/xml' -# html_extra_path = ['../build/html'] \ No newline at end of file +# html_extra_path = ['../build/html'] + +# -- Project information ----------------------------------------------------- + +project = 'knx' +copyright = '2019, Thomas Kunze' +author = 'Thomas Kunze' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +#... + +extensions = [ "breathe" ] + +#... + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- 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 = 'sphinx_rtd_theme' + +# 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'] + +# Breathe Configuration +breathe_default_project = "knx" \ No newline at end of file diff --git a/doc/sphinx/contents.rst b/doc/sphinx/contents.rst index 3708689..08fb960 100644 --- a/doc/sphinx/contents.rst +++ b/doc/sphinx/contents.rst @@ -1,2 +1,11 @@ .. toctree:: - :maxdepth: 2 \ No newline at end of file + :maxdepth: 2 + :caption: Contents: + +:ref:`genindex` + +Docs +==== + +.. doxygenstruct:: GroupObject + :members: \ No newline at end of file diff --git a/doc/requirements.txt b/doc/sphinx/requirements.txt similarity index 100% rename from doc/requirements.txt rename to doc/sphinx/requirements.txt