From 1a6b812276326d03869cd78d3a184868233c05d4 Mon Sep 17 00:00:00 2001 From: Matthias Baumgartner Date: Wed, 1 Mar 2023 13:05:10 +0100 Subject: documentation skeleton --- doc/source/_static/arch_dark.png | Bin 0 -> 27346 bytes doc/source/_static/arch_dark.svg | 500 ++++++++++++++++++++++++++++++++++++++ doc/source/_static/arch_light.png | Bin 0 -> 17509 bytes doc/source/_static/arch_light.svg | 499 +++++++++++++++++++++++++++++++++++++ doc/source/conf.py | 37 +++ 5 files changed, 1036 insertions(+) create mode 100644 doc/source/_static/arch_dark.png create mode 100644 doc/source/_static/arch_dark.svg create mode 100644 doc/source/_static/arch_light.png create mode 100644 doc/source/_static/arch_light.svg create mode 100644 doc/source/conf.py (limited to 'doc/source') diff --git a/doc/source/_static/arch_dark.png b/doc/source/_static/arch_dark.png new file mode 100644 index 0000000..b5ea1b3 Binary files /dev/null and b/doc/source/_static/arch_dark.png differ diff --git a/doc/source/_static/arch_dark.svg b/doc/source/_static/arch_dark.svg new file mode 100644 index 0000000..22de237 --- /dev/null +++ b/doc/source/_static/arch_dark.svg @@ -0,0 +1,500 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + Graph + Nodes + AC + + Backend + + App + Lib + + Config + + Query AST + + Schema + + Utils + + + Front + Center + Back + Envelope + + + Client + + + + + + + + diff --git a/doc/source/_static/arch_light.png b/doc/source/_static/arch_light.png new file mode 100644 index 0000000..c210ecf Binary files /dev/null and b/doc/source/_static/arch_light.png differ diff --git a/doc/source/_static/arch_light.svg b/doc/source/_static/arch_light.svg new file mode 100644 index 0000000..e93694c --- /dev/null +++ b/doc/source/_static/arch_light.svg @@ -0,0 +1,499 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + Graph + Nodes + AC + + Backend + + App + Lib + + Config + + Query AST + + Schema + + Utils + + + Front + Center + Back + Envelope + + + Client + + + + + + + + diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..6de4993 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,37 @@ +# 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 ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Black Star File System' +copyright = '2023, Matthias Baumgartner' +author = 'Matthias Baumgartner' +release = '0.5' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'sphinx_copybutton', + 'sphinx.ext.autodoc', + ] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'furo' +html_static_path = ['_static'] + +html_title = 'bsfs' +html_theme_options = { + 'announcement': 'This project is under heavy development and subject to rapid changes. Use at your own discretion.', + } + -- cgit v1.2.3