feat(getting-started): initial commit

getting-started/.gitignore

@@ -0,0 +1,5 @@
+bundle
+build
+venv
+*.*~
+*~

getting-started/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)

getting-started/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

getting-started/readme.md

@@ -0,0 +1,60 @@
+# Introduction
+
+* setup the project
+```
+sphinx-quickstart
+```
+
+* install Sphinx
+```
+https://www.sphinx-doc.org/en/master/usage/installation.html
+```
+
+* get started with Sphinx
+```
+https://www.sphinx-doc.org/en/master/usage/quickstart.html#
+```
+
+# Build Documentation
+
+## Running Generator via Make
+
+Execute make without an argument to see which targets are available
+```
+make
+```
+
+The top level directory contains a Makefile.
+Generate HTML output
+```
+make html
+```
+
+Generate PDF output
+```
+make latexpdf
+```
+
+The output files can be found in the subfolder `./build`.
+
+All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.
+
+Generate all output
+```
+make bundle
+```
+
+### Clean up
+
+1. Deactivate the virtual Python environment: ```deactivate```
+2. Clean up the build sources: ```make clean```
+
+# File System
+
+* `build`: build directory
+* `Makefile`: build configuration
+* `readme.md`: this file
+* `source`: source directory
+# Links
+
+* [getting started](https://www.sphinx-doc.org/en/master/usage/quickstart.html)

getting-started/source/conf.py

@@ -0,0 +1,28 @@
+# 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 = 'getting-started'
+copyright = '2023, Stefan Begerad'
+author = 'Stefan Begerad'
+release = '1.0.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+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'
+html_static_path = ['_static']

getting-started/source/index.rst

@@ -0,0 +1,20 @@
+.. getting-started documentation master file, created by
+   sphinx-quickstart on Thu Apr 13 17:31:40 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to getting-started's documentation!
+===========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`