From 845bdcd056a053a0ac9020cbba6dab9038a5226a Mon Sep 17 00:00:00 2001 From: Kyle Isom Date: Wed, 12 Apr 2023 05:46:49 +0000 Subject: [PATCH] starting docs --- docs/Makefile | 20 ++++++++++++++++ docs/conf.py | 55 +++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 26 ++++++++++++++++++++ docs/make.bat | 35 +++++++++++++++++++++++++++ docs/packer.rst | 4 ++++ docs/requirements.txt | 1 + netlify.toml | 4 ++++ 7 files changed, 145 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100644 docs/packer.rst create mode 100644 docs/requirements.txt create mode 100644 netlify.toml diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /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 = . +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/conf.py b/docs/conf.py new file mode 100644 index 0000000..22802f2 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,55 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'bladerunner' +copyright = '2023, kyle' +author = 'kyle' + +# The full version, including alpha/beta/rc tags +release = '0.0.1-pre' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..fbced9b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,26 @@ +.. bladerunner documentation master file, created by + sphinx-quickstart on Wed Apr 12 05:16:47 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +bladerunner +=========== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + packer + +This is my setup for my +`computeblade `_ +cluster, which will theoretically be here around September 2023. + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..153be5e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%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 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/packer.rst b/docs/packer.rst new file mode 100644 index 0000000..10d478d --- /dev/null +++ b/docs/packer.rst @@ -0,0 +1,4 @@ +packer +====== + +`packer `_ is used to generate the base images for the cluster. \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..182f69b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +Sphinx==4.3.2 \ No newline at end of file diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 0000000..b03d442 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,4 @@ +[build] +base = "docs" +command = "make html" +publish = "docs/_build/html" \ No newline at end of file