mirror of
https://github.com/jkriege2/JKQtPlotter.git
synced 2024-12-25 10:01:38 +08:00
add ReadTheDocs build
This commit is contained in:
parent
625669c0ad
commit
da394e4c6f
40
doc/sphinx/conf.py
Normal file
40
doc/sphinx/conf.py
Normal file
@ -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)
|
22
doc/sphinx/index.rst
Normal file
22
doc/sphinx/index.rst
Normal file
@ -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 <https://world.openfoodfacts.org/>`_
|
||||
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
|
Loading…
Reference in New Issue
Block a user