[IMP] Add readthedocs and update requirements

miikanissi · Aug 17, 2023 · 65d73e8 · 65d73e8
1 parent 3432211
commit 65d73e8
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/docs/requirements.in b/docs/requirements.in
@@ -1,2 +1,3 @@
 Sphinx>=6
 sphinx_rtd_theme
+sphinx-autodoc-typehints
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile docs/requirements.in
+#    pip-compile requirements.in
 #
 alabaster==0.7.13
     # via sphinx
@@ -34,16 +34,19 @@ snowballstemmer==2.2.0
     # via sphinx
 sphinx==6.2.1
     # via
-    #   -r docs/requirements.in
+    #   -r requirements.in
+    #   sphinx-autodoc-typehints
     #   sphinx-rtd-theme
     #   sphinxcontrib-applehelp
     #   sphinxcontrib-devhelp
     #   sphinxcontrib-htmlhelp
     #   sphinxcontrib-jquery
     #   sphinxcontrib-qthelp
     #   sphinxcontrib-serializinghtml
+sphinx-autodoc-typehints==1.23.0
+    # via -r requirements.in
 sphinx-rtd-theme==1.2.2
-    # via -r docs/requirements.in
+    # via -r requirements.in
 sphinxcontrib-applehelp==1.0.7
     # via sphinx
 sphinxcontrib-devhelp==1.0.5

diff --git a/pyproject.toml b/pyproject.toml
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "zebrafy"
 version = "1.0.0"
-description = "Python library for converting Zebra Programming Language (ZPL) to and from PDF, HTML, and images"
+description = "Python library for converting PDF and images to Zebra Programming Language (ZPL)"
 classifiers = [
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
@@ -54,6 +54,7 @@ content-type = "text/x-rst"
 
 [project.urls]
 Homepage = "https://github.com/miikanissi/zebrafy/"
+Documentation = "https://zebrafy.readthedocs.io/"
 
 [tool.setuptools]
 include-package-data = false