Add READme docs

docs/source/code.rst

@@ -6,7 +6,7 @@ Models
 *******
 
 .. automodule:: main.models
-   :members:
+    :members:
 
 
 ******

docs/source/conf.py

@@ -114,12 +114,15 @@ def skip_queryset(app, what, name, obj, skip, options):
         return True
     return skip
 
+def fix_sig(app, what, name, obj, options, signature, return_annotation):
+    return ("", "")
 
-# def setup(app):
-#     # Register the docstring processor with sphinx
-#     app.connect('autodoc-process-docstring', process_django_models)
-#     app.connect('autodoc-skip-member', skip_queryset)
-#     app.connect('autodoc-process-docstring', process_modules)
+def setup(app):
+    # Register the docstring processor with sphinx
+    app.connect('autodoc-process-docstring', process_django_models)
+    app.connect('autodoc-skip-member', skip_queryset)
+    app.connect('autodoc-process-docstring', process_modules)
+    app.connect("autodoc-process-signature", fix_sig)
 
 
 
@@ -181,7 +184,7 @@ intersphinx_mapping = {
 }
 
 autodoc_default_flags = ['members']
-autodoc_typehints = "none"
+autodoc_typehints = "description"
 
 # spell checking
 spelling_lang = 'ru_RU'

docs/source/index.rst

@@ -12,6 +12,7 @@
 
    overview
    code
+   readme
    todo
 
 

docs/source/readme.rst

@@ -0,0 +1,4 @@
+READ.me
+==================
+
+.. include:: ../../README.md

docs/source/spelling_wordlist.txt

@@ -45,7 +45,9 @@ start
 end
 date
 Токен
+токен
 токеном
+токену
 аутентифицирован
 (datetime.time)
 datetime
@@ -82,7 +84,23 @@ Serializer
 Serializers
 Сериализатор
 переадресации
-
-
-
+чекбоксов
+админских
+админские
+Python
+Docker
+докер
+докера
+Докер
+репозиторий
+zendesk-access-controller/db
+-e
+-v
+e
+v
+zendesk
+db
+юзерами
+Read
+Zenpy