diff --git a/docs/source/conf.py b/docs/source/conf.py index f4f84cc48bc5f7c22ea8d173dc39fc8c2af388ff..92d0244b888d2ed952ac39826584a94c51227e8c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,36 +1,29 @@ # Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -# -- Project information +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'DART-WRF' -copyright = '2023, University of Vienna' +copyright = '2023, Lukas Kugler' author = 'Lukas Kugler' +release = '2023.2.17' -release = '0.1' -version = '0.1.0' +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# -- 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'] +extensions = [] templates_path = ['_templates'] +exclude_patterns = [] -# -- Options for HTML output +root_doc = 'index2' -html_theme = 'sphinx_rtd_theme' -# -- Options for EPUB output -epub_show_urls = 'footnote' +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/source/conf.py_old b/docs/source/conf.py_old new file mode 100644 index 0000000000000000000000000000000000000000..f4f84cc48bc5f7c22ea8d173dc39fc8c2af388ff --- /dev/null +++ b/docs/source/conf.py_old @@ -0,0 +1,36 @@ +# Configuration file for the Sphinx documentation builder. + +# -- Project information + +project = 'DART-WRF' +copyright = '2023, University of Vienna' +author = 'Lukas Kugler' + +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' + diff --git a/docs/source/index2.rst b/docs/source/index2.rst new file mode 100644 index 0000000000000000000000000000000000000000..993e6a3d7d8874f0d3c9ad84933439de14a57f7c --- /dev/null +++ b/docs/source/index2.rst @@ -0,0 +1,20 @@ +.. DART-WRF documentation master file, created by + sphinx-quickstart on Fri Feb 17 17:22:54 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to DART-WRF's documentation! +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`