diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/.nix/derivation.nix | 12 | ||||
-rw-r--r-- | docs/Doxygen.in | 4 | ||||
-rw-r--r-- | docs/Makefile | 20 | ||||
-rw-r--r-- | docs/source/_static/css/custom.css | 15 | ||||
-rw-r--r-- | docs/source/conf.py | 30 | ||||
-rw-r--r-- | docs/source/index.rst | 22 | ||||
-rw-r--r-- | docs/source/manual/introduction.rst | 4 |
7 files changed, 102 insertions, 5 deletions
diff --git a/docs/.nix/derivation.nix b/docs/.nix/derivation.nix index 929113d..a6dee7d 100644 --- a/docs/.nix/derivation.nix +++ b/docs/.nix/derivation.nix @@ -23,16 +23,20 @@ stdenvNoCC.mkDerivation { buildPhase = '' # C++ API generation - doxygen docs/Doxygen.in - python3 ${gasp.outPath}/bin/gasp.py xml --namespace duke > cpp_map.json + pushd docs + doxygen Doxygen.in + python3 ${gasp.outPath}/bin/gasp.py xml --namespace saw > cpp_map.json # C++ and C template generation mkdir -p source/cpp_api - python3 ${gasp.outPath}/bin/make_rst.py --title="C++" -t ${gasp.outPath}/templates/rst -m cpp_map.json -o source/cpp_api + python3 ${gasp.outPath}/bin/make_rst.py --title="C++" -t ${gasp.outPath}/templates/rst -m cpp_map.json -o source/cpp_api make html + popd ''; installPhase = '' mkdir -p $out - mv docs/html $out/html + pushd docs + mv build/html $out/html + popd ''; } diff --git a/docs/Doxygen.in b/docs/Doxygen.in index d9005ba..59f2014 100644 --- a/docs/Doxygen.in +++ b/docs/Doxygen.in @@ -1,5 +1,7 @@ GENERATE_XML = YES +GENERATE_LATEX= NO +GENERATE_HTML = NO PROJECT_NAME = forstio RECURSIVE = YES FILE_PATTERNS = *.cpp *.hpp -INPUT = modules +INPUT = ../modules diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/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/source/_static/css/custom.css b/docs/source/_static/css/custom.css new file mode 100644 index 0000000..ba76c62 --- /dev/null +++ b/docs/source/_static/css/custom.css @@ -0,0 +1,15 @@ +:root { + --content-background-color: #fff5e1; + --navbar-background-color: #263547; + --navbar-heading-color: #eeeeee; +} + +.wy-nav-side { + background: var(--navbar-background-color); +} + +.classref-section-separator { + border-color: var(--navbar-heading-color); + border-top-width: 3px; + margin: 36px 0; +} diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..07c21ad --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,30 @@ +# 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 = 'forstio docs' +copyright = '2024, Claudius "keldu" Holeksa' +author = 'Claudius "keldu" Holeksa' +release = '2024' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'sphinx_rtd_theme' +] + +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 = 'sphinx_rtd_theme' +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..b994f13 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,22 @@ +.. Gasp Example documentation master file, created by + sphinx-quickstart on Tue Aug 22 16:01:56 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Gasp Example's documentation! +======================================== + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Manual + + manual/introduction + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: API Reference + + c_api/index + cpp_api/index diff --git a/docs/source/manual/introduction.rst b/docs/source/manual/introduction.rst new file mode 100644 index 0000000..edf7742 --- /dev/null +++ b/docs/source/manual/introduction.rst @@ -0,0 +1,4 @@ +Introduction +============ + +This is an example intro. |