From 5c5a1c965fc6f26bc19b319e91e779827f3c5735 Mon Sep 17 00:00:00 2001 From: Eljakim Herrewijnen Date: Sat, 19 Nov 2022 20:18:59 +0100 Subject: [PATCH] Added readthedocs --- Readme.md | 5 +++++ documentation/readthedocs/Makefile | 20 +++++++++++++++++ documentation/readthedocs/conf.py | 27 ++++++++++++++++++++++ documentation/readthedocs/index.rst | 20 +++++++++++++++++ documentation/readthedocs/make.bat | 35 +++++++++++++++++++++++++++++ 5 files changed, 107 insertions(+) create mode 100644 documentation/readthedocs/Makefile create mode 100644 documentation/readthedocs/conf.py create mode 100644 documentation/readthedocs/index.rst create mode 100644 documentation/readthedocs/make.bat diff --git a/Readme.md b/Readme.md index e69de29..eff26b6 100644 --- a/Readme.md +++ b/Readme.md @@ -0,0 +1,5 @@ +# Ithamar Associate Degree assignments +This repository contains the code and projects that Ithamar is doing and has done for his Associate Degree. + +## Structure +the documentation/ folder contains the **readthedocs** source that will be updated by Ithamar according to the assignments he needs to make. The **assignments** folder contains the assignments made by Ithamar. \ No newline at end of file diff --git a/documentation/readthedocs/Makefile b/documentation/readthedocs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/documentation/readthedocs/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/documentation/readthedocs/conf.py b/documentation/readthedocs/conf.py new file mode 100644 index 0000000..d694040 --- /dev/null +++ b/documentation/readthedocs/conf.py @@ -0,0 +1,27 @@ +# 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 = "Ithamar's AD" +copyright = '2022, Ithamar' +author = 'Ithamar' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- 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'] diff --git a/documentation/readthedocs/index.rst b/documentation/readthedocs/index.rst new file mode 100644 index 0000000..7ad6af6 --- /dev/null +++ b/documentation/readthedocs/index.rst @@ -0,0 +1,20 @@ +.. Ithamar's AD documentation master file, created by + sphinx-quickstart on Sat Nov 19 20:17:07 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Ithamar's AD's documentation! +======================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/documentation/readthedocs/make.bat b/documentation/readthedocs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/documentation/readthedocs/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 + +%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