README.md

@@ -5,9 +5,10 @@
 ![](docs/_images/telegram.png)
 
  <!-- some shields -->
-<!-- [![Documentation Status](https://readthedocs.org/projects/sparser/badge/?version=latest)](https://sparser.readthedocs.io/ru/latest/?badge=latest) -->
-
 <p align="center">
+  <a href='https://sparser.readthedocs.io/ru/latest/?badge=latest'>
+    <img src='https://readthedocs.org/projects/sparser/badge/?version=latest' alt='Documentation Status' />
+  </a>
   <img alt="Version" src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fnotabug.org%2Fmilinuri%2Fsparser%2Fraw%2Fmaster%2Fpyproject.toml&query=tool.poetry.version&prefix=v&label=SParser&color=green">
   <img alt="License" src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fnotabug.org%2Fmilinuri%2Fsparser%2Fraw%2Fmaster%2Fpyproject.toml&query=tool.poetry.license&label=License&color=red">
   <img alt="Python verion" src="https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fnotabug.org%2Fmilinuri%2Fsparser%2Fraw%2Fmaster%2Fpyproject.toml&query=tool.poetry.dependencies.python&label=Python">
@@ -267,6 +268,8 @@ python spcli.py
 
 ## Возможности парсера
 
+> Этот раздел перемещается в документацию ...
+
 На одном парсере всё не заканчивается.
 В проекте представлен класс `sp.parser.Schedule` для работы с расписанием.
 Например для поиска уроков/кабинетов и просмотра списка изменений.
@@ -326,43 +329,3 @@ python spcli.py
 - Отправка расписания уроков. (использует намерения)
   - Отображение изменений в расписании пользователя при наличии.
 - Отправка расписания уроков на сегодня/завтра. (использует намерения)
-
-`sp.parser` **Парсер**:
-
-- Отслеживание изменений во всём расписании.
-- Получение индексов расписания (`l_index`, `c_index`).
-  - Словарь по урокам/кабинетом.
-  - Какие, когда, где и для кого проводятся уроки/кабинеты.
-- Парсер уроков (`CSV -> Dict`).
-- Умное обновление расписания.
-  - Ежечасное сравнение хешей расписания.
-  - Если хеши расписаний отличаются - начинается процесс обновления.
-  - Обновляется расписание, индексы, список изменений.
-  - Результаты работы сохраняются в `sp_data/`.
-- Получение списка уроков для выбранного класса.
-- Получение списка обновлений в расписании (использует фильтры).
-- Поиск данных в расписании (использует фильтры).
-
-`sp.utils` **Дополнительные инструменты**:
-
-- Сжатие списка изменений в расписании.
-
-## Документация
-
-![](docs/_images/docs.png)
-
-После завершения документации, многие разделы будут убраны из README.
-
-Для всех заинтересованных в проекте появилась оффлайн документация.
-
-Для сборки оффлайн документации. загрузите необходимые зависимости.
-
-```bash
-poetry install --with docs
-```
-
-Дальше перейдите в директорию `docs/` и выполните:
-
-```bash
-make html
-```

docs/conf.py

@@ -32,7 +32,7 @@ language = 'ru'
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'furo'
+html_theme = 'sphinx_book_theme'
 html_logo = "_images/sp_ava.png"
 html_static_path = ['_static']
 highlight_language = "python3"

docs/contributing.rst

@@ -0,0 +1,12 @@
+Содействие
+==========
+
+SParser - открытый проект!
+Вы можете спокойно использовать проект в своих целях.
+Мы будем очень рады, если вы внесёте свой вклад в развитие проекта.
+
+Этот раздел подскажет чем вы можете помочь проекту.
+
+.. note::
+
+    Этот раздел будет дополнен после.

docs/index.rst

@@ -17,3 +17,4 @@
    install
    sp/index
    changelog
+   contributing

docs/sp/counters.rst

@@ -3,9 +3,7 @@ counters
 
 .. automodule:: sp.counters
 
-.. warning::
-
-    **Не завершённый раздел.**
+.. todo:: Раздел в процессе.
 
     Раздел будет дополнен после рефакторинга кода
     соответствующего модуля в проекте.

docs/sp/index.rst

@@ -2,13 +2,32 @@
 ============
 
 Этот раздел посвящён ядру проекта - `SParse`.
-Также в этом разделе описывается принцип работы парсера.
+В этом разделе описывается принцип работы парсера.
 Класс расписания и его методы для работы с расписанием.
-Счётчики для подсчёта элементтов в расписании.
-А также генартор сообщений и его методы, для преобразования
+Счётчики для подсчёта элементов в расписании.
+А также генератор сообщений и его методы, для преобразования
 результатов работы класса `Schedule` в текстовые сообщения,
 чтобы использовать их в чат ботах.
 
+.. todo:: Документация пополняется.
+
+    На данный момент некоторые разделы пустые и представялют собой
+    загрушки.
+    Это связано с рефакторингом проекта.
+    Разделы будут пополнятся после переработки соответствующих модулей.
+
+    **Разделы в процессе**:
+
+    - Счётчики.
+    - Намерения.
+    - Генератор сообщений.
+    - Парсер.
+
+    **Готовые разлелы**:
+
+    - (`sp.utils`) Утилиты.
+
+
 .. toctree::
     :maxdepth: 2
 

docs/sp/intents.rst

@@ -3,9 +3,7 @@ intents
 
 .. automodule:: sp.intents
 
-.. warning::
-
-    **Не завершённый раздел.**
+.. todo:: Раздел в процессе.
 
     Раздел будет дополнен после рефакторинга кода
     соответствующего модуля в проекте.

docs/sp/messages.rst

@@ -3,9 +3,7 @@ messages
 
 .. automodule:: sp.messages
 
-.. warning::
-
-    **Не завершённый раздел.**
+.. todo:: Раздел в процессе.
 
     Раздел будет дополнен после рефакторинга кода
     соответствующего модуля в проекте.

docs/sp/parser.rst

@@ -9,3 +9,57 @@ parser
 
     Раздел будет дополнен после рефакторинга кода
     соответствующего модуля в проекте.
+
+
+Функции для работы с расписанием
+--------------------------------
+
+Некоторые отдельные функции, которые используются при работе
+с расписанием и могут быть использованы отдельно от экземпляра класса
+`Scheule`.
+
+.. autofunction:: get_sc_updates
+
+.. autofunction:: get_index
+
+.. autofunction:: parse_lessons
+
+
+Класс расписания
+----------------
+
+Используется для прямой работы с самим расписанием уроков.
+Предоставляет так называемые "сырые" результаты.
+Которые вы после можете самостоятельно обработать.
+
+.. hint:: Генератор сообщений.
+
+    Если же вас интересует готовый результат, обратитесь к
+    классу представления или так называемому **генератору сообщений**.
+    В отличие от класса расписания, класс представления возвращает
+    уже готовые текстовые сообщения, которые вы можете испльзовать
+    например в чат-ботах.
+
+.. autoclass:: sp.parser.Schedule
+
+    Аттрибуты расписания:
+
+    .. autoproperty:: l_index
+
+    .. autoproperty:: c_index
+
+    .. autoproperty:: updates
+
+    Методы для получения расписания:
+
+    .. automethod:: get
+
+    Методы для работы с расписанием:
+
+    .. automethod:: get_class
+
+    .. automethod:: get_lessons
+
+    .. automethod:: get_updates
+
+    .. automethod:: search