From da394e4c6f9bfdcf717628e0ff6d75982250f153 Mon Sep 17 00:00:00 2001 From: jkriege2 Date: Sat, 13 May 2023 14:44:40 +0200 Subject: [PATCH] add ReadTheDocs build --- doc/sphinx/conf.py | 40 ++++++++++++++++++++++++++++++++++++++++ doc/sphinx/index.rst | 22 ++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 doc/sphinx/conf.py create mode 100644 doc/sphinx/index.rst diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py new file mode 100644 index 0000000000..7cfcdd217f --- /dev/null +++ b/doc/sphinx/conf.py @@ -0,0 +1,40 @@ +# Configuration file for the Sphinx documentation builder. + +# -- Project information + +project = 'JKQTPlotter' +copyright = '2008-2023, Jan Krieger' +author = 'Jan Krieger' + +release = '0.1' +version = '0.1.0' + +# -- General configuration + +extensions = [ + 'sphinx.ext.duration', + 'sphinx.ext.doctest', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', +] + +intersphinx_mapping = { + 'python': ('https://docs.python.org/3/', None), + 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), +} +intersphinx_disabled_domains = ['std'] + +templates_path = ['_templates'] + +# -- Options for HTML output + +html_theme = 'sphinx_rtd_theme' + +# -- Options for EPUB output +epub_show_urls = 'footnote' + +html_extra_path = ['../build/html'] + +import subprocess +subprocess.call('cd ../.. ; doxygen', shell=True) \ No newline at end of file diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst new file mode 100644 index 0000000000..03d09a55d0 --- /dev/null +++ b/doc/sphinx/index.rst @@ -0,0 +1,22 @@ +Welcome to Lumache's documentation! +=================================== + +**Lumache** (/lu'make/) is a Python library for cooks and food lovers +that creates recipes mixing random ingredients. +It pulls data from the `Open Food Facts database `_ +and offers a *simple* and *intuitive* API. + +Check out the :doc:`usage` section for further information, including +how to :ref:`installation` the project. + +.. note:: + + This project is under active development. + +Contents +-------- + +.. toctree:: + + usage + api