diff options
author | aktersnurra <gustaf.rydholm@gmail.com> | 2020-06-02 22:49:22 +0200 |
---|---|---|
committer | aktersnurra <gustaf.rydholm@gmail.com> | 2020-06-02 22:49:22 +0200 |
commit | 118c02c2730aaac2d10c2b9847339f6ffc83223f (patch) | |
tree | f7e1dc9a7159b63945a19d742a525f20c90c969e /docs | |
parent | 81d48b6a4da96696afde87a54f9fb7d89dd64cd2 (diff) |
Working on lab 1.
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 +----- |