Translate README.md to README.rst

2021-04-25 17:51:50 +03:00
parent b5f5fdf9dc
commit 015d5f65a7
6 changed files with 83 additions and 46 deletions
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -139,7 +139,8 @@ extensions = {
    'sphinx.ext.graphviz',
    'sphinx.ext.inheritance_diagram',
    'sphinx_autodoc_typehints',
-    'sphinxcontrib.spelling'
+    'sphinxcontrib.spelling',
+

 }

@@ -173,6 +174,7 @@ html_static_path = ['_static']

 # -- Extension configuration -------------------------------------------------

+
 # -- Options for intersphinx extension ---------------------------------------

 # Example configuration for intersphinx: refer to the Python standard library.
@@ -211,3 +213,4 @@ always_document_param_types = True
 typehints_document_rtype = True

 napoleon_attr_annotations = True
+
--- a/docs/source/readme.rst
+++ b/docs/source/readme.rst
@@ -1,4 +1,4 @@
 READ.me
 ==================

-.. include:: ../../README.md
+.. include:: ../../README.rst