diff --git a/.gitignore b/.gitignore index 7b70f42..835ee8f 100644 --- a/.gitignore +++ b/.gitignore @@ -31,3 +31,5 @@ dist/ venv/ .tox/ .docker/ +docs_sphinx/venv/ +docs_sphinx/build/ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..7c8201e --- /dev/null +++ b/docs/index.html @@ -0,0 +1,100 @@ + + + + + + Apache Otava Documentation + + + + + +
+ +

Apache Otava Documentation

+ +

+ Structured entry point to the Otava documentation, replacing the default directory listing. +

+ +
+

Documentation

+ +
+ +
+

Project

+ +
+ +
+ + + \ No newline at end of file diff --git a/docs_sphinx/Makefile b/docs_sphinx/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs_sphinx/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs_sphinx/make.bat b/docs_sphinx/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/docs_sphinx/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs_sphinx/source/conf.py b/docs_sphinx/source/conf.py new file mode 100644 index 0000000..4d9cc2a --- /dev/null +++ b/docs_sphinx/source/conf.py @@ -0,0 +1,36 @@ +# Configuration file for the Sphinx documentation builder. +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) + +# 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 = 'otava' +copyright = '2026, Apache Otava' +author = 'Apache Otava' +release = '0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ["myst_parser"] + +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 = 'alabaster' +source_suffix = { + ".rst": "restructuredtext", + ".md": "markdown", +} +html_static_path = ['_static'] diff --git a/docs_sphinx/source/index.rst b/docs_sphinx/source/index.rst new file mode 100644 index 0000000..b49957b --- /dev/null +++ b/docs_sphinx/source/index.rst @@ -0,0 +1,18 @@ +Welcome to Apache Otava Documentation +==================================== + +.. toctree:: + :maxdepth: 2 + + ../../docs/README.md + ../../docs/INSTALL.md + ../../docs/GETTING_STARTED.md + ../../docs/BASICS.md + ../../docs/CSV.md + ../../docs/BIG_QUERY.md + ../../docs/POSTGRESQL.md + ../../docs/GRAFANA.md + ../../docs/GRAPHITE.md + + +This documentation is powered by Sphinx and supports Markdown via MyST.