[doc] Switch to autoapi for doc generation (#88)

* Switch to autoapi for doc generation

* Update README link

Author: rhaist

.gitignore

@@ -11,4 +11,5 @@ test.py
 *.iml
 examples/*.json
 examples/*.pdf
-docs/_build
+docs/_build
+Pipfile*

.readthedocs.yml

@@ -21,3 +21,4 @@ python:
   version: 3.8
   install:
     - requirements: requirements.txt
+    - requirements: docs/requirements.txt

README.md

@@ -26,7 +26,7 @@ To learn about how to use the OpenCTI Python client and read some examples and c
 
 ### API reference
 
-To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://opencti-client-for-python.readthedocs.io/en/latest/modules/modules.html).
+To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://opencti-client-for-python.readthedocs.io/en/latest/pycti/pycti.html).
 
 ## About
 

docs/conf.py

@@ -27,14 +27,14 @@
 
 master_doc = "index"
 
+autoapi_modules = {"pycti": {"prune": True}}
+
 # -- 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",
-]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.inheritance_diagram", "autoapi.sphinx"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/index.rst

@@ -10,8 +10,9 @@ The Python library requires Python >= 3.
    :maxdepth: 2
    :caption: Contents:
 
-   modules/modules.rst
    client_usage/getting_started.rst
+   pycti/pycti
+
 
 Indices and tables
 ==================