docs: change from pdoc to sphinx (#136)

* docs: change from pdoc to sphinx Signed-off-by: Timothy MacDonald <[email protected]> * chore: update poetry lock file Signed-off-by: Timothy MacDonald <[email protected]> * chore: update poetry files Signed-off-by: Timothy MacDonald <[email protected]> * docs: removed autogen content Added readme pointing to github pages instead. Signed-off-by: Timothy MacDonald <[email protected]> * docs: fix minor issues Update copywrite and tweak docks-build command Signed-off-by: Timothy MacDonald <[email protected]> --------- Signed-off-by: Timothy MacDonald <[email protected]>
lacework · Dec 20, 2023 · da7b2e9 · da7b2e9
1 parent 9c2e858
commit da7b2e9
Show file tree

Hide file tree

Showing 53 changed files with 326 additions and 32,474 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -29,11 +29,11 @@ jobs:
         run: |
           poetry install
 
-      - run: poetry run pdoc laceworksdk --logo https://techally-content.s3-us-west-1.amazonaws.com/public-content/lacework_logo_full.png -o docs/
+      - run: poetry run poe docs
 
       - uses: actions/upload-pages-artifact@v1
         with:
-          path: docs/
+          path: docs/html
 
   # Deploy the artifact to GitHub pages.
   deploy:

diff --git a/docs-source/conf.py b/docs-source/conf.py
@@ -0,0 +1,67 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../laceworksdk'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Lacework Python SDK'
+copyright = '2023, Lacework'
+author = 'Jon Stewart, Tim MacDonald'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.napoleon']
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = True
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+html_logo = 'https://techally-content.s3-us-west-1.amazonaws.com/public-content/lacework_logo_full.png'
+html_theme_options = {
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': False,
+    'vcs_pageview_mode': '',
+    'style_nav_header_background': 'white',
+    # Toc options
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': -1,
+    'includehidden': False,
+    'titles_only': False
+}
diff --git a/docs-source/index.rst b/docs-source/index.rst
@@ -0,0 +1,16 @@
+
+Welcome to Lacework Python SDK's documentation!
+===============================================
+
+.. toctree::
+    :maxdepth: 5
+
+    auto/modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,2 @@
+# The Lacework SDK docs are hosted on Github Pages [here](https://lacework.github.io/python-sdk/)
+
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/laceworksdk.html b/docs/laceworksdk.html
diff --git a/docs/laceworksdk/api.html b/docs/laceworksdk/api.html
diff --git a/docs/laceworksdk/api/base_endpoint.html b/docs/laceworksdk/api/base_endpoint.html
diff --git a/docs/laceworksdk/api/crud_endpoint.html b/docs/laceworksdk/api/crud_endpoint.html
diff --git a/docs/laceworksdk/api/read_endpoint.html b/docs/laceworksdk/api/read_endpoint.html
diff --git a/docs/laceworksdk/api/search_endpoint.html b/docs/laceworksdk/api/search_endpoint.html
diff --git a/docs/laceworksdk/api/v1.html b/docs/laceworksdk/api/v1.html
diff --git a/docs/laceworksdk/api/v2.html b/docs/laceworksdk/api/v2.html
diff --git a/docs/laceworksdk/api/v2/activities.html b/docs/laceworksdk/api/v2/activities.html
diff --git a/docs/laceworksdk/api/v2/agent_access_tokens.html b/docs/laceworksdk/api/v2/agent_access_tokens.html
diff --git a/docs/laceworksdk/api/v2/agent_info.html b/docs/laceworksdk/api/v2/agent_info.html
diff --git a/docs/laceworksdk/api/v2/alert_channels.html b/docs/laceworksdk/api/v2/alert_channels.html
diff --git a/docs/laceworksdk/api/v2/alert_profiles.html b/docs/laceworksdk/api/v2/alert_profiles.html
diff --git a/docs/laceworksdk/api/v2/alert_rules.html b/docs/laceworksdk/api/v2/alert_rules.html
diff --git a/docs/laceworksdk/api/v2/alerts.html b/docs/laceworksdk/api/v2/alerts.html
diff --git a/docs/laceworksdk/api/v2/audit_logs.html b/docs/laceworksdk/api/v2/audit_logs.html
diff --git a/docs/laceworksdk/api/v2/cloud_accounts.html b/docs/laceworksdk/api/v2/cloud_accounts.html
diff --git a/docs/laceworksdk/api/v2/cloud_activities.html b/docs/laceworksdk/api/v2/cloud_activities.html
diff --git a/docs/laceworksdk/api/v2/configs.html b/docs/laceworksdk/api/v2/configs.html
diff --git a/docs/laceworksdk/api/v2/container_registries.html b/docs/laceworksdk/api/v2/container_registries.html
diff --git a/docs/laceworksdk/api/v2/contract_info.html b/docs/laceworksdk/api/v2/contract_info.html
diff --git a/docs/laceworksdk/api/v2/datasources.html b/docs/laceworksdk/api/v2/datasources.html
diff --git a/docs/laceworksdk/api/v2/entities.html b/docs/laceworksdk/api/v2/entities.html
diff --git a/docs/laceworksdk/api/v2/events.html b/docs/laceworksdk/api/v2/events.html
diff --git a/docs/laceworksdk/api/v2/inventory.html b/docs/laceworksdk/api/v2/inventory.html
diff --git a/docs/laceworksdk/api/v2/organization_info.html b/docs/laceworksdk/api/v2/organization_info.html
diff --git a/docs/laceworksdk/api/v2/policies.html b/docs/laceworksdk/api/v2/policies.html
diff --git a/docs/laceworksdk/api/v2/policy_exceptions.html b/docs/laceworksdk/api/v2/policy_exceptions.html
diff --git a/docs/laceworksdk/api/v2/queries.html b/docs/laceworksdk/api/v2/queries.html
diff --git a/docs/laceworksdk/api/v2/report_definitions.html b/docs/laceworksdk/api/v2/report_definitions.html
diff --git a/docs/laceworksdk/api/v2/report_rules.html b/docs/laceworksdk/api/v2/report_rules.html
diff --git a/docs/laceworksdk/api/v2/reports.html b/docs/laceworksdk/api/v2/reports.html
diff --git a/docs/laceworksdk/api/v2/resource_groups.html b/docs/laceworksdk/api/v2/resource_groups.html
diff --git a/docs/laceworksdk/api/v2/schemas.html b/docs/laceworksdk/api/v2/schemas.html
diff --git a/docs/laceworksdk/api/v2/team_members.html b/docs/laceworksdk/api/v2/team_members.html
diff --git a/docs/laceworksdk/api/v2/team_users.html b/docs/laceworksdk/api/v2/team_users.html
diff --git a/docs/laceworksdk/api/v2/user_groups.html b/docs/laceworksdk/api/v2/user_groups.html
diff --git a/docs/laceworksdk/api/v2/user_profile.html b/docs/laceworksdk/api/v2/user_profile.html
diff --git a/docs/laceworksdk/api/v2/vulnerabilities.html b/docs/laceworksdk/api/v2/vulnerabilities.html
diff --git a/docs/laceworksdk/api/v2/vulnerability_exceptions.html b/docs/laceworksdk/api/v2/vulnerability_exceptions.html
diff --git a/docs/laceworksdk/api/v2/vulnerability_policies.html b/docs/laceworksdk/api/v2/vulnerability_policies.html
diff --git a/docs/laceworksdk/config.html b/docs/laceworksdk/config.html
diff --git a/docs/laceworksdk/exceptions.html b/docs/laceworksdk/exceptions.html
diff --git a/docs/laceworksdk/http_session.html b/docs/laceworksdk/http_session.html
diff --git a/docs/laceworksdk/version.html b/docs/laceworksdk/version.html
diff --git a/docs/search.js b/docs/search.js