♻️ refactor docs

# Build documentation in the docs/ directory with Sphinx

sphinx:

  configuration: docs/conf.py

# Build documentation with MkDocs

# mkdocs:

#   configuration: mkdocs.yml

  configuration: docs/source/conf.py

# Optionally build your docs in additional formats such as PDF and ePub

formats: all

python:

  version: 3.7

  install:

    - requirements: docs/requirements.txt

    - requirements: requirements-docs.txt

# from the environment for the first two.

SPHINXOPTS    ?=

SPHINXBUILD   ?= sphinx-build

SOURCEDIR     = .

BUILDDIR      = _build

SOURCEDIR     = source

BUILDDIR      = build

# Put it first so that "make" without argument is like "make help".

help:

generate docs in html, run

```

pip install -r requirements.txt

make html

open _build/html/index.html

$ pip install -r ../requirements-docs.txt

$ make html

// clean build

$ make clean html

$ open build/html/index.html

```

You can generate docs in other formats as well if you like. To clean up past builds run

If you want to confirm logs in more detail

```

make clean

$ make clean html SPHINXOPTS=-vvv

```

@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