Verified Commit b4ea86e2 authored by David LJ's avatar David LJ
Browse files

Initial documentation

parent eafd0051
Loading
Loading
Loading
Loading

.gitignore

0 → 100644
+1 −0
Original line number Diff line number Diff line
build/*

Makefile

0 → 100644
+20 −0
Original line number Diff line number Diff line
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
SPHINXPROJ    = BlockValley
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)
 No newline at end of file
+2 −0
Original line number Diff line number Diff line
<?xml version="1.0" encoding="UTF-8"?>
<mxfile modified="2018-12-24T17:38:00.659Z" host="www.draw.io" agent="Mozilla/5.0 (X11; U; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.869 Safari/537.36" etag="v-bis-NimF9YB8d20_cp" version="10.0.8" type="google"><diagram id="Q7vk5FiSrlfv7Dvc4Cy5" name="Page-1">7Vttc6o4GP01zn66Du/qR7R1787cdd16d3rnfulEiJhtJE6Irb2/fhMJKAm0lFqwO51OW3wIgXBOznN4iD17stn/TsF2/ScJIe5ZRrjv2Vc9yzIdy+P/ROQpjQxGVhqIKAplo2NggX5BGTRkdIdCmBQaMkIwQ9tiMCBxDANWiAFKyWOx2Yrg4lm3IIJaYBEArEdvUcjWaXToGsf4V4iidXZm05B7NiBrLAPJGoTk8SRkX/fsCSWEpVub/QRicfOy+5IeN63Ym18YhTGrc8DYn5mDn+HNfmnYc+fnYndLF18sJ+3mAeCdHHHP8jDvcLzkG5HYmPsL3sLq8z//zP7oTezeyObbPv/9Jv788G9++NlR/Pz5gXLc7Cm7mZTs4hCK6zH47sc1YnCxBYHY+8jpw2NrtsH8k8k3VwjjCcGEHo61VyvoBQGPJ4ySe3iyJxyMloboEIMlxHOSIIZIzPcF/M5A3mj8AClDHNNvSgNGxDkBRlFpc1/uWBLGyCYfkNgN95UomDm2fFJAsoGMPvEm8gBPskFOB0d+fDxyK4+tT3hl2zIIJJ+jvOcj5HxDov4aBth1GWAKBlzPvt/4VxVwy8PoOxFgZVUQwFt6rvdBCGAbgyIDrL6rc8BzdQ6Y1hk44MPvv5y9G3z9e7b9NbJv4/kEf7E0CszIjgdiLucahrmOCQhDkKxzPE+wK2IUkxjqgLqG+GkOWyVKZMcwivnZs5RglIHMx7EVQ9rsI5G6+mS1QgHs80QSwC1L+mLwdxGMIUVBDr2GcwkbKqEfFpEfeCXIO54OvGu9E+761J8TyoBI17/xYVIQgrJJnUZQFljyFJYyJdcE9ApNqAI5h7NaEnzTtX2jhAoV81qFPEBJQO4SsIJ9bjJ44z4IApgkd1uCYnYe0J3M8EjUh2Xz3S2RfMd9J8UflAj+szp9AsC/kLEn6dLAjhEx2yhbk4jEHEEibruc/4AyX/gvgSQmwX0WnCKcdQbjUG3CQycN0uuCoWbRNDwSsqMBfIbq0ufwK4gge+bmeOVgUogBQw/F6zj7fNTN2Owwrwy/xjSkMNphQBvOwgtQ9XzCl8/mS1X1UdHRWQOrNVGvZnAZiaafJHpPEr3JFVp20RuYI6dbFrkvJwmhywv58ZgEro/R8f8vjbg104jTZRrRsZMKUDqHPxXgItKIOSzmEXuolwZaVYBKMzKpwaIEAgw/SdR2GrEdpzMSlUqRbkb0NKLLdwHmehlAk/szPSQ8J7BKRtFReeEJL4vVzgryDPPD0+nROyg1RdtQ6kTpuOVRpxVipSPbVKysq3SU3hitowMz8mE3V5yySmQnD6bNDEPpmLJ3Fi8ZBqslw/DcRepSf/VpGC5W652RXZz2ZseGwapi0fWnYbhUEtlK9aLz505T16K2HMNZ9N57m9634xjyt4mZdHhNHYP60GK26xhMXXM+FFvqVqU79ZeOohGOagvrssV11JffLbOlhsE8YUuAQZKgQCXJMXxCo2aceFOJqVsFUR4VbKepgigPL3k5vS1OlC2AuThOfAidUCtYXtOsYinpyWs7q9QpfnfOibo60S0n3CKU7rApJwylI3VB1HtzosZb81Y58Sb32SknBsrsbpo68vVQGSXaTh3DC6PEm1JHxRurlkqYzpk4ob6Nb50TI40Tfy0ZjAMk1s2OxbrZQ0lkCyFNzsWWvOJhZpWLMQjuo0Ot9KS4MZ1OrcmkpLhBUzwraxsbFIaH97lZwQLD1Wn7rNSRtzsjfS2dvtVL2S7FDZuGsnarthseKUsE88ViLfE3k9TL1rS6pOhU01Tr01zTVOvTsqZZryvJXQ4nXrPAryVOKN7HaswJxfuYZ+ME/3j8Tkra/PjNHvv6Pw==</diagram></mxfile>
 No newline at end of file

img/overview.png

0 → 100644
+47.9 KiB
Loading image diff...

make.bat

0 → 100644
+36 −0
Original line number Diff line number Diff line
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
	set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=BlockValley

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.http://sphinx-doc.org/
	exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
Loading