#462 python hosted documentation

.github/workflows/documentation.yml

@@ -0,0 +1,45 @@
+name: Documentation
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+        lfs: true
+    - name: Install Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10'
+    - name: Install pipenv
+      uses: dschep/install-pipenv-action@v1
+    - name: Install dependencies
+      run: pipenv install --dev    
+    - name: Build docs      
+      uses: ammaraskar/sphinx-action@master
+      with:
+        pre-build-command: "pip install sphinx_rtd_theme && sphinx-apidoc -f -o docs meilisearch/"
+        docs-folder: "docs/"
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_build/html
+        force_orphan: true   
+
+
+
+
+
+
+
+
+
+
+
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'meilisearch-python'
+copyright = '2019, Meili SAS'
+author = 'Charlotte Vermandel'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+#html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []

docs/index.rst

@@ -0,0 +1,22 @@
+.. meilisearch-python documentation master file, created by
+   sphinx-quickstart on Sun Oct  2 13:24:48 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to meilisearch-python's documentation!
+==============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+.. include:: modules.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/meilisearch.models.rst

@@ -0,0 +1,37 @@
+meilisearch.models package
+==========================
+
+Submodules
+----------
+
+meilisearch.models.document module
+----------------------------------
+
+.. automodule:: meilisearch.models.document
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+meilisearch.models.index module
+-------------------------------
+
+.. automodule:: meilisearch.models.index
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+meilisearch.models.task module
+------------------------------
+
+.. automodule:: meilisearch.models.task
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: meilisearch.models
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/meilisearch.rst

@@ -0,0 +1,69 @@
+meilisearch package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   meilisearch.models
+
+Submodules
+----------
+
+meilisearch.client module
+-------------------------
+
+.. automodule:: meilisearch.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+meilisearch.config module
+-------------------------
+
+.. automodule:: meilisearch.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+meilisearch.errors module
+-------------------------
+
+.. automodule:: meilisearch.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+meilisearch.index module
+------------------------
+
+.. automodule:: meilisearch.index
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+meilisearch.task module
+-----------------------
+
+.. automodule:: meilisearch.task
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+meilisearch.version module
+--------------------------
+
+.. automodule:: meilisearch.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: meilisearch
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules.rst

@@ -0,0 +1,7 @@
+meilisearch
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   meilisearch

meilisearch/client.py

@@ -327,7 +327,6 @@ def update_key(
         """Update an API key.
 
         Parameters
-
         ----------
         key:
             The key or the uid of the key for which to update the information.

meilisearch/index.py

@@ -143,8 +143,8 @@ def get_tasks(self, parameters: dict[str, Any] | None = None) -> TaskResults:
         -------
         tasks:
         TaskResults instance with attributes:
-            - from_
-            - next_
+            - from
+            - next
             - limit
             - results : list of Task instances containing all enqueued, processing, succeeded or failed tasks of the index