diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 6 | ||||
| -rw-r--r-- | docs/index.rst | 22 |
2 files changed, 28 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..a0eba8b --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +"""Sphinx configuration.""" + +project = "text-recognizer" +author = "Gustaf Rydholm" +extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_autodoc_typehints"] +html_static_path = ["_static"] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..bef49c6 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +The Text Recognizer Project +============================== + +TBC + + +Installation +------------ + + +TBC + + +run this command in your terminal: + +.. code-block:: console + + $ pip install text-recognizer + + +Usage +----- |