docs: Update docs for readthedocs

Author: tembleking

.github/workflows/ci-master.yaml

@@ -30,7 +30,9 @@
 # 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.linkcode', 'sphinx.ext.napoleon']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel', 'sphinx.ext.graphviz',
+              'sphinx.ext.inheritance_diagram', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary',
+              'sphinx.ext.githubpages', 'sphinx.ext.napoleon']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -102,7 +104,7 @@
 # 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 = ['static']
+html_static_path = []
 
 # -- Options for HTMLHelp output ------------------------------------------
 
@@ -157,31 +159,10 @@
      'Miscellaneous'),
 ]
 
-
-def linkcode_resolve(domain, info):
-    def find_line():
-        obj = sys.modules[info['module']]
-        for part in info['fullname'].split('.'):
-            obj = getattr(obj, part)
-        import inspect
-        source, lineno = inspect.findsource(obj)
-        return lineno + 1
-
-    if domain != 'py' or not info['module']:
-        return None
-
-    # tag = 'master' if 'dev' in release else ('v' + release)
-    url = "https://github.com/sysdiglabs/sysdig-sdk-python/blob/master/sdcclient/_client.py"
-    try:
-        return url + '#L%d' % find_line()
-    except Exception:
-        return url
-
-
 # Napoleon settings
 napoleon_google_docstring = True
 napoleon_include_init_with_doc = False
-napoleon_include_private_with_doc = False
+napoleon_include_private_with_doc = True
 napoleon_include_special_with_doc = True
 napoleon_use_admonition_for_examples = False
 napoleon_use_admonition_for_notes = False

doc/index.rst

@@ -0,0 +1,24 @@
+.. python-sdc-client documentation master file, created by
+   sphinx-quickstart on Thu Dec 22 11:59:02 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Sysdig SDK for Python
+=====================
+
+This module is a wrapper around the Sysdig Monitor/Sysdig Secure APIs.
+It exposes most of the sysdig REST API functionality as an easy to use and easy to
+install Python interface.
+
+.. toctree::
+   :maxdepth: 2
+
+   install
+   usage
+   monitor
+   secure
+
+
+.. autosummary::
+
+

doc/Makefile renamed to docs/Makefile

@@ -0,0 +1,22 @@
+Installation
+============
+
+Automatic with PyPI
+-------------------
+
+::
+
+   $ pip install sdcclient
+
+Manual (development only)
+-------------------------
+
+This method requires `Poetry`_ installed.
+
+.. _Poetry: https://python-poetry.org/
+
+::
+
+    $ git clone https://github.com/sysdiglabs/sysdig-sdk-python.git
+    $ cd python-sdc-client
+    $ poetry install

doc/conf.py renamed to docs/conf.py

@@ -0,0 +1,9 @@
+.. automodule:: sdcclient
+
+Sysdig Monitor
+=====================
+.. inheritance-diagram:: SdMonitorClient
+.. autoclass:: SdMonitorClient
+   :members:
+   :inherited-members:
+   :undoc-members:

docs/index.rst

@@ -0,0 +1,2 @@
+sphinx==3.3.1
+sphinx-material==0.0.32

docs/install.rst

@@ -0,0 +1,8 @@
+.. automodule:: sdcclient
+Sysdig Secure
+====================
+
+.. autoclass:: SdSecureClient
+   :members:
+   :inherited-members:
+   :undoc-members: