diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..451bedae --- /dev/null +++ b/docs/README.md @@ -0,0 +1,2 @@ +```{include} ../README.md +``` diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..b89a0137 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,37 @@ +# Configuration file for the Sphinx documentation builder. + +# -- Project information + +project = 'DBMSBenchmarker' +copyright = '2021, Patrick Erdelt' +author = 'Patrick Erdelt' + +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', + "myst_parser", +] + +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' +html_static_path = ['_static'] + +# -- Options for EPUB output +epub_show_urls = 'footnote' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..d6261b42 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,7 @@ +.. toctree:: + :maxdepth: 2 + :caption: Table of Contents: + + ../README.md + ... +.. mdinclude:: ../README.md diff --git a/requirements.txt b/requirements.txt index f43a7e71..d9b3f9b2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -39,3 +39,4 @@ six>=1.14.0 urllib3==1.26.5 uuid>=1.30 Werkzeug>=1.0.1 +myst-parser diff --git a/setup.py b/setup.py index 7ef11266..c9eb4ca6 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setuptools.setup( name="dbmsbenchmarker", - version="0.11.13", + version="0.11.14", author="Patrick Erdelt", author_email="perdelt@beuth-hochschule.de", description="DBMS-Benchmarker is a Python-based application-level blackbox benchmark tool for Database Management Systems (DBMS). It connects to a given list of DBMS (via JDBC) and runs a given list of parametrized and randomized (SQL) benchmark queries. Evaluations are available via Python interface, in reports and at an interactive multi-dimensional dashboard.",