docs: Add some structure to documentation (#176)

Néstor Salceda · web-flow · commit a7aa51c433fd · 2020-11-30T17:26:11.000+01:00
* docs: Simplify structure and work with left bars

* fix: Fix a couple of issues on documentation

* fix: Use the Read the docs theme

This was just to read how to use it with left bars
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,6 +18,7 @@
 #
 import os
 import sys
+from datetime import datetime
 
 sys.path.insert(0, os.path.abspath('..'))
 
@@ -32,7 +33,7 @@
 # ones.
 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']
+              'sphinx.ext.githubpages', 'sphinx.ext.napoleon', 'sphinx_rtd_theme']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -48,7 +49,7 @@
 
 # General information about the project.
 project = u'Sysdig SDK for Python'
-copyright = u'2016, Sysdig Inc.'
+copyright = f'2016-{datetime.now().year}, Sysdig Inc.'
 author = u'Sysdig Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -83,23 +84,13 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_material'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-html_theme_options = {
-    'nav_title': 'Sysdig SDK for Python',
-    'base_url': 'https://sysdiglabs.github.io/sysdig-sdk-python',
-    'color_primary': 'blue',
-    'color_accent': 'light-blue',
-    'repo_url': 'https://github.com/sysdiglabs/sysdig-sdk-python/',
-    'repo_name': 'Sysdig SDK for Python',
-    'globaltoc_depth': 3,
-    'globaltoc_collapse': False,
-    'globaltoc_includehidden': False,
-}
+html_theme_options = {}
 
 # 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,
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,24 +1,28 @@
-.. 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
+Having troubles? We would like to help you!
+
+* Looking for specific information? Try the :ref:`genindex`
+* Check out the `Sysdig Documentation`_.
+* Ask a question in the `Sysdig Slack`_.
 
-   install
-   usage
-   monitor
-   secure
+.. _Sysdig Documentation: https://docs.sysdig.com
+.. _Sysdig Slack: https://sysdig.slack.com
 
 
-.. autosummary::
+.. toctree::
+   :caption: Quick start
+
+   quickstart/install
+   quickstart/usage
 
+.. toctree::
+   :caption: API Core Reference
 
+   reference/monitor
+   reference/secure
diff --git a/docs/quickstart/install.rst b/docs/quickstart/install.rst
diff --git a/docs/quickstart/usage.rst b/docs/quickstart/usage.rst
@@ -22,8 +22,3 @@ They can be instantiated like this:
 
     # Instantiate the Sysdig Monitor client
     client = SdMonitorClient(api_token)
-
-
-* :ref:`genindex`
-* :ref:`search`
-
diff --git a/docs/reference/monitor.rst b/docs/reference/monitor.rst
@@ -1,8 +1,8 @@
-.. automodule:: sdcclient
-
 Sysdig Monitor
-=====================
+==============
+
 .. inheritance-diagram:: SdMonitorClient
+.. automodule:: sdcclient
 .. autoclass:: SdMonitorClient
    :members:
    :inherited-members:
diff --git a/docs/reference/secure.rst b/docs/reference/secure.rst
@@ -1,7 +1,7 @@
-.. automodule:: sdcclient
 Sysdig Secure
-====================
+=============
 
+.. automodule:: sdcclient
 .. autoclass:: SdSecureClient
    :members:
    :inherited-members:
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
 sphinx==3.3.1
-sphinx-material==0.0.32
+sphinx-rtd-theme==0.5.0
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`sphinx==3.3.1`
`2`		`-sphinx-material==0.0.32`
	`2`	`+sphinx-rtd-theme==0.5.0`