readthedocs

docs/conf.py

@@ -10,15 +10,21 @@
     "sphinx.ext.todo",
     "sphinx.ext.intersphinx",
     "sphinx_rtd_theme",
+    'sphinx_search.extension',  # search tools
+    'sphinx.ext.autodoc',
 ]
+pygments_style = "sphinx"
+autoapi_type = 'python'
 templates_path = ["_templates"]
 source_suffix = ".rst"
 master_doc = "index"
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 html_theme = "sphinx_rtd_theme"
+html_logo = 'images/logo.png'
 html_use_smartypants = True
 html_last_updated_fmt = "%b %d, %Y"
 html_split_index = False
+html_static_path = ['_static']
 html_sidebars = {
     "**": ["searchbox.html", "globaltoc.html", "sourcelink.html"],
 }

pyproject.toml

@@ -38,15 +38,22 @@ nose = "^1.3.7"
 ml2rt = "^0.2.0"
 tox = ">=3.23.1"
 tox-poetry = "^0.3.0"
+Sphinx = "^4.1.2"
+sphinx-rtd-theme = "^0.5.2"
+readthedocs-sphinx-search = "^0.1.0"
+sphinx-autoapi = "^1.8.3"
+toml = "^0.10.2"
 bandit = "^1.7.0"
 pylint = "^2.8.2"
 vulture = "^2.3"
 scikit-image = "==0.16.2"
 
 [tool.poetry.urls]
-url = "https://redisai.io"
-repository = "https://github.com/RedisAI/redisai-py"
-
+"Project URL" = "https://redisai.io"
+Repository = "https://github.com/RedisAI/redisai-py"
+Documentation = "https://redisai.readhtedocs.io"
+Homepage = "https://oss.redislabs.com/redisai/"
+Tracker = "https://github.com/RedisAI/redisai-py/issues"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tox.ini

@@ -20,3 +20,6 @@ commands =
   flake8 --show-source
   vulture redisai --min-confidence 80
   bandit redisai/**
+
+[testenv:docs]
+commands = make html