Updates from rebasing

Cray-HPE · Sep 13, 2023 · cdd2912 · cdd2912
1 parent 373b72b
commit cdd2912
Show file tree

Hide file tree

Showing 51 changed files with 658 additions and 32 deletions.
diff --git a/GNUmakefile b/GNUmakefile
@@ -162,7 +162,7 @@ help:
 	@echo '	   docs					Generate Python sphinx documentation.'
 
 clean:
-	rm -rf build dist .ruff_cache
+	rm -rf build dist .ruff_cache docs/_build
 
 docs:
 	sphinx-build -b html ./docs ./docs/_build

diff --git a/docs/conf.py b/docs/conf.py
@@ -41,21 +41,42 @@
 
 project = 'libCSM'
 copyright = '2023, Cray / HPE'
+master_doc = 'index'
 author = 'Russell Bunch, Mitchell Tishmack, Jacob Salmela'
 
 # -- General configuration ---------------------------------------------------
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx_copybutton',
+    'sphinx.ext.autosectionlabel',
     'sphinx_autodoc_typehints',
+    'sphinx_copybutton',
+    'sphinx_rtd_theme',
 ]
-
+autosectionlabel_prefix_document = True
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 html_title = f"{project} Documentation ({version})"
+locale_dirs = ['locale/']   # path is example but recommended.
+language = 'en'
+gettext_compact = False     # optional.
+versioning_conditions = ['text']
+add_function_parentheses = True
+add_module_names = True
 
 # -- Options for HTML output -------------------------------------------------
-html_theme = 'alabaster'
+html_show_sphinx = False
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    'logo_only': False,
+    'navigation_depth': 5,
+}
 html_static_path = ['_static']
 html_favicon = '_static/favicon.ico'
 html_logo = '_static/csm.jpeg'
+html_context = {
+    'display_github': True,
+    'github_user': 'Cray-HPE',
+    'github_repo': 'libCSM',
+    'github_version': 'main',
+}
+
diff --git a/docs/libcsm.api.rst b/docs/libcsm.api.rst
@@ -0,0 +1,8 @@
+libcsm.api module
+=================
+
+.. automodule:: libcsm.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.bss.api.rst b/docs/libcsm.bss.api.rst
@@ -0,0 +1,11 @@
+libcsm.bss.api module
+=====================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.bss.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.bss.rst b/docs/libcsm.bss.rst
@@ -0,0 +1,20 @@
+libcsm.bss package
+==================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.bss.api
+   libcsm.bss.set_image
+
+Module contents
+---------------
+
+.. automodule:: libcsm.bss
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.bss.set_image.rst b/docs/libcsm.bss.set_image.rst
@@ -0,0 +1,11 @@
+libcsm.bss.set_image module
+===========================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.bss.set_image
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.hsm.components.rst b/docs/libcsm.hsm.components.rst
@@ -0,0 +1,11 @@
+libcsm.hsm.components module
+============================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.hsm.components
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.hsm.rst b/docs/libcsm.hsm.rst
@@ -0,0 +1,20 @@
+libcsm.hsm package
+==================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.hsm.components
+   libcsm.hsm.xnames
+
+Module contents
+---------------
+
+.. automodule:: libcsm.hsm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.hsm.xnames.rst b/docs/libcsm.hsm.xnames.rst
@@ -0,0 +1,11 @@
+libcsm.hsm.xnames module
+========================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.hsm.xnames
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.logger.rst b/docs/libcsm.logger.rst
@@ -0,0 +1,8 @@
+libcsm.logger module
+====================
+
+.. automodule:: libcsm.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.os.rst b/docs/libcsm.os.rst
@@ -0,0 +1,8 @@
+libcsm.os module
+================
+
+.. automodule:: libcsm.os
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.requests.rst b/docs/libcsm.requests.rst
@@ -0,0 +1,20 @@
+libcsm.requests package
+=======================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.requests.session
+
+Module contents
+---------------
+
+.. automodule:: libcsm.requests
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
diff --git a/docs/libcsm.requests.session.rst b/docs/libcsm.requests.session.rst
@@ -0,0 +1,11 @@
+libcsm.requests.session module
+==============================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.requests.session
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.rst b/docs/libcsm.rst
@@ -1,11 +1,34 @@
-API Reference
-=============
+libcsm package
+==============
 
-.. automodule:: libcsm
-    :members:
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.bss
+   libcsm.hsm
+   libcsm.requests
+   libcsm.s3
+   libcsm.sls
+   libcsm.tests
+
+Submodules
+-----------
 
-``api``
--------
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.api
+   libcsm.os
+   libcsm.logger
+
+Module contents
+---------------
+
+.. automodule:: libcsm
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-.. automodule:: libcsm.api
-    :members:
diff --git a/docs/libcsm.s3.images.rst b/docs/libcsm.s3.images.rst
@@ -0,0 +1,11 @@
+libcsm.s3.images module
+=======================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.s3.images
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.s3.rst b/docs/libcsm.s3.rst
@@ -0,0 +1,20 @@
+libcsm.s3 package
+=================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.s3.images
+   libcsm.s3.s3object
+
+Module contents
+---------------
+
+.. automodule:: libcsm.s3
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.s3.s3object.rst b/docs/libcsm.s3.s3object.rst
@@ -0,0 +1,11 @@
+libcsm.s3.s3object module
+=========================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.s3.s3object
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.sls.api.rst b/docs/libcsm.sls.api.rst
@@ -0,0 +1,11 @@
+libcsm.sls.api module
+=====================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.sls.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.sls.get_hostname.rst b/docs/libcsm.sls.get_hostname.rst
@@ -0,0 +1,11 @@
+libcsm.sls.get_hostname module
+==============================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.sls.get_hostname
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.sls.get_xname.rst b/docs/libcsm.sls.get_xname.rst
@@ -0,0 +1,11 @@
+libcsm.sls.get_xname module
+===========================
+
+Module contents
+---------------
+
+.. automodule:: libcsm.sls.get_xname
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.sls.rst b/docs/libcsm.sls.rst
@@ -0,0 +1,21 @@
+libcsm.sls package
+==================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.sls.api
+   libcsm.sls.get_hostname
+   libcsm.sls.get_xname
+
+Module contents
+---------------
+
+.. automodule:: libcsm.sls
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.tests.bss.rst b/docs/libcsm.tests.bss.rst
@@ -0,0 +1,20 @@
+libcsm.tests.bss package
+========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   libcsm.tests.bss.test_api
+   libcsm.tests.bss.test_set_image
+
+Module contents
+---------------
+
+.. automodule:: libcsm.tests.bss
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.tests.bss.test_api.rst b/docs/libcsm.tests.bss.test_api.rst
@@ -0,0 +1,12 @@
+libcsm.tests.bss.test_api module
+================================
+
+
+Module contents
+---------------
+
+.. automodule:: libcsm.tests.bss.test_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/libcsm.tests.bss.test_set_image.rst b/docs/libcsm.tests.bss.test_set_image.rst
@@ -0,0 +1,12 @@
+libcsm.tests.bss.test_set_image module
+======================================
+
+
+Module contents
+---------------
+
+.. automodule:: libcsm.tests.bss.test_set_image
+   :members:
+   :undoc-members:
+   :show-inheritance:
+