(#3) Добавление наброска документации:

* Добавлен набросок документации;
* Переименованы директории;
* Убрана из lib функция read_input (alias остался).

Author: Pavel Sobolev

.gitignore

@@ -7,4 +7,12 @@ tmp
 *__pycache__
 
 # Архивы для публикации
-dist
+dist
+
+# Файлы Visual Studio Code
+.vscode
+
+# Директории сборки документации
+*_build
+*_static
+*_templates

.rtd-environment.yml

@@ -0,0 +1,6 @@
+name: scats
+
+dependencies:
+  - python=3.7
+  - numpy
+  - pybind11

Makefile

@@ -44,16 +44,14 @@
 
      ## Правило для установки версии с TestPyPI
      install-testpypi :
-	                   python3 -m pip install setuptools
-	                   python3 -m pip install wheel
-	                   python3 -m pip install pybind11
-	                   python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps scats
+	                   python3 -m pip install -r requirements
+				    python3 -m pip install pybind11
+	                   python3 -m pip install --no-cache-dir --index-url https://test.pypi.org/simple/ --no-deps scats
 
      ## Правило для установки версии с PyPI
      install-pypi :
-	               python3 -m pip install setuptools
-	               python3 -m pip install wheel
-	               python3 -m pip install scats
+	               python3 -m pip install -r requirements
+	               python3 -m pip install --no-cache-dir scats
 
      ## Правило для установки версии для разработчика
      develop :
@@ -77,12 +75,12 @@
 
      ## Правило для запуска скрипта examples/example.py
      example :
-	          cd Примеры && python3 main.py && cd ../
+	          cd examples && python3 main.py && cd ../
 
      ## Правило для удаления локальной сборки
      clean :
-	        rm -rf build Модуль/scats/scats.egg-info Модуль/scats/*.so \
-	        Модуль/scats/__pycache__ build tmp
+	        rm -rf build src/scats/scats.egg-info src/scats/*.so \
+	        src/scats/__pycache__ build tmp
 
      ## Правило для удаления модуля
      uninstall :
@@ -225,6 +223,6 @@
 
      # Правило для создания архивов
      archive :
-	          find Библиотека/ -path '*/*' -type f -print | zip Архивы/Библиотека.zip -FS -q -@
-			find Модуль/ -path '*/*' -type f -print | zip Архивы/Модуль.zip -FS -q -@
-	          find Примеры/ -path '*/.*' -prune -o -type f -print | zip Архивы/Примеры.zip -FS -q -@
+	          find lib/ -path '*/*' -type f -print | zip archives/lib.zip -FS -q -@
+			find src/ -path '*/*' -type f -print | zip archives/src.zip -FS -q -@
+	          find examples/ -path '*/.*' -prune -o -type f -print | zip archives/examples.zip -FS -q -@

README.md

@@ -1,2 +1,2 @@
 [![](https://img.shields.io/badge/GitHub-Paveloom/C3.1-5DA399.svg)](https://github.com/Paveloom/C3.1) [![](https://img.shields.io/badge/license-Unlicense-5DA399.svg)](https://github.com/Paveloom/C3/blob/master/LICENSE.md) <br>
-[![](https://img.shields.io/badge/release-v0.2.2-informational.svg)](https://github.com/Paveloom/C3.1/releases/tag/v0.2.2) [![](https://img.shields.io/badge/platforms-linux,%20macOS-3E6680.svg)](#) [![](https://img.shields.io/badge/requires-python%203.7%2B-critical.svg)](https://www.python.org/downloads/) [![](https://img.shields.io/pypi/format/scats.svg)](https://pypi.org/project/scats/) [![](https://img.shields.io/pypi/status/scats.svg)](#)
+[![](https://img.shields.io/badge/release-v0.2.3-informational.svg)](https://github.com/Paveloom/C3.1/releases/tag/v0.2.3) [![](https://img.shields.io/badge/platforms-linux,%20macOS-3E6680.svg)](#) [![](https://img.shields.io/badge/requires-python%203.7%2B-critical.svg)](https://www.python.org/downloads/) [![](https://img.shields.io/pypi/format/scats.svg)](https://pypi.org/project/scats/) [![](https://img.shields.io/pypi/status/scats.svg)](#)

Архивы/Примеры.zip renamed to archives/examples.zip

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+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)

archives/lib.zip

@@ -0,0 +1,9 @@
+Внешний API
+===========
+
+Эта страница описывает класс, позволяющий, как предполагается, полностью
+использовать функционал модуля. Экземпляры используемых внутри классов более подробно
+описаны в разделе :ref:`internal`.
+
+.. autoclass:: scats.api
+    :members:

archives/src.zip

@@ -0,0 +1,16 @@
+.. _internal:
+
+Внутренний API
+==============
+
+Этот раздел описывает встроенные в :class:`scats.api` структуры данных,
+в каждой из которых описан соответствующий интерфейс взаимодействия.
+Вы можете создавать экземпляры этих классов при необходимости, не смотря
+на то, что концепт этого модуля подразумевает использование только внешнего API.
+Вы также можете напрямую получать и изменять значения аттрибутов этих классов.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Содержимое
+
+   internal/input