(f)SCHA.T.S.I

(f)SCHA.T.S.I - An abbreviation for 'faster SCHeduling Algorithm for Text Seach Intelligence'.

Getting Started

https://python-poetry.org/

pip install poetry
poetry lock
.venv\Scripts\activate
poetry config virtualenvs.in-project true
poetry install

Generate documentation

Theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html apidoc documentation: https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html

os.environ["SPHINX_APIDOC_OPTIONS"]="members,show-inheritance"

Windows

cd docs
sphinx-apidoc -lfM -d 0 -o schatsi/ ../src/schatsi
.\make.bat html

Mac/Linux

cd docs
sphinx-apidoc -lfM -d 0 -o schatsi/ ../src/schatsi
make html