Done with sphinx and code testing.

Author: Jan Schaffranek

.gitignore

@@ -68,8 +68,8 @@ instance/
 .webassets-cache
 # Scrapy stuff:
 .scrapy
-# Sphinx documentation
-documentation/_build/
+# Sphinx docs
+docs/_build/
 # PyBuilder
 target/
 # Jupyter Notebook
@@ -106,7 +106,7 @@ venv.bak/
 .spyproject
 # Rope project settings
 .ropeproject
-# mkdocs documentation
+# mkdocs docs
 /site
 # mypy
 .mypy_cache/

GenerateDoc.bat

@@ -0,0 +1,4 @@
+cd docs
+call sphinx-apidoc -o source/ ../fastvector/
+call make html
+cd ..

Makefile

@@ -1,25 +1,24 @@
 SRC_APP=app
 SRC_CORE=fastvector
 SRC_TEST=tests
-SRC_DOC=documentation
+SRC_DOC=docs
 
 ifeq ($(OS), Windows_NT)
 	PYTHON=python
 	PIP=pip
 	RM=del /Q
 	FixPath=$(subst /,\,$1)
-	BUILD_DOC=sphinx-apidoc -o source/ ./fastvector/ && $(SRC_DOC)\make.bat html
+	BUILD_DOC=sphinx-apidoc -o ./$(SRC_DOC)/source/ ./fastvector/ && $(SRC_DOC)\make.bat html
 else
 	PYTHON=python3
 	PIP=pip3
 	RM=rm -f
 	FixPath=$1
-	BUILD_DOC=sphinx-apidoc -o source/ ./fastvector/ && ./$(SRC_DOC)/make.sh
+	BUILD_DOC=sphinx-apidoc -o ./$(SRC_DOC)/source/ ./fastvector/ && ./$(SRC_DOC)/make.sh
 endif
 
 help:
 	@echo "Some available commands:"
-	@echo " * run          		- Run code."
 	@echo " * test         		- Run unit tests and test coverage."
 	@echo " * doc          		- Document code (pydoc)."
 	@echo " * clean        		- Cleanup (e.g. pyc files)."
@@ -33,9 +32,6 @@ help:
 	@echo " * deps-install 		- Install dependencies (see requirements.txt)."
 	@echo " * deps-dev-install 	- Install dev. dependencies (see requirements-dev.txt)."
 
-run:
-	@$(PYTHON) $(SRC_APP)/main.py
-
 test:
 	@pytest --cov=./$(SRC_TEST)/
 	@codecov

README.md

@@ -25,7 +25,7 @@ This is a template for Python projects. What you get:
 ├── Makefile
 ├── requirements.txt
 ├── requirements-dev.txt
-└── documentation
+└── docs
 │   └── build_docs.bat
 │   └── build_docs.sh
 ├── fastvector

app/main.py

@@ -1,2 +1,2 @@
-call sphinx-apidoc -o source/ ../fastvector/
+call sphinx-apidoc -o source/ ../fastvector/
 call make.bat html

documentation/Makefile renamed to docs/Makefile

@@ -1,2 +1,2 @@
-sphinx-apidoc -o source/ ../fastvector/
+sphinx-apidoc -o source/ ../fastvector/
 sphinx-build -b html ./source/ ./build/

documentation/build_docs.bat renamed to docs/build_docs.bat

@@ -1,35 +1,35 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-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.http://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
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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.http://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

documentation/build_docs.sh renamed to docs/build_docs.sh

@@ -0,0 +1 @@
+sphinx-build -b html ./docs/source/ ./docs/build/