mirror of
https://github.com/gryf/coach.git
synced 2025-12-18 03:30:19 +01:00
1b095aeeca
Till now, most of the modules were importing all of the module objects (variables, classes, functions, other imports) into module namespace, which potentially could (and was) cause of unintentional use of class or methods, which was indirect imported. With this patch, all the star imports were substituted with top-level module, which provides desired class or function. Besides, all imports where sorted (where possible) in a way pep8[1] suggests - first are imports from standard library, than goes third party imports (like numpy, tensorflow etc) and finally coach modules. All of those sections are separated by one empty line. [1] https://www.python.org/dev/peps/pep-0008/#imports
installation ============= 1. install mkdocs by following the instructions here - http://www.mkdocs.org/#installation 2. install the math extension for mkdocs sudo -E pip install python-markdown-math to build the documentation website run: - mkdocs build - python fix_index.py this will create a folder named site which contains the documentation website