fix sphinx

add sphinx install

fix sphinx

fix version

fix sphinx build

fix sphinx

test new copyright year

fix docstrings and sphinx

sphinx napoleon

show cloudmesh.ee instead of cloudmesh

Author: jpfleischer

.github/workflows/main.yml

@@ -20,6 +20,7 @@ jobs:
         run: |
           python -m pip install -r requirements.txt
           python -m pip install -r requirements-dev.txt
+          python -m pip install -r requirements-sphinx.txt
           python -m pip install -e .
 
       - name: Build Sphinx Site

.gitignore

@@ -91,3 +91,5 @@ ENV/
 
 # Rope project settings
 .ropeproject
+
+docs/source/generated/

docs/Makefile

@@ -23,7 +23,8 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	make -f Makefile man
-	sphinx-apidoc -o source ../cloudmesh
+	mkdir -p source/generated
+	python -m sphinx.ext.apidoc -o source/generated ../src/cloudmesh --implicit-namespaces -f --remove-old
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 #man:

docs/source/api.rst

@@ -1,15 +1,7 @@
-Cloudmesh ee
-================
-
-.. autosummary::
-   :toctree: generated
-
-   cloudmesh.ee
-   manual/ee
-
-.. rubric:: Modules
-
-.. toctree::
-   :maxdepth: 2
-
-   modules
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   generated/cloudmesh.ee

docs/source/cloudmesh.ee.command.rst

@@ -9,14 +9,15 @@
 import sphinx_rtd_theme
 import os
 import sys
-import cloudmesh.ee
-from cloudmesh.ee.__version__ import version as cc_version
+
+from importlib.metadata import version as pkg_version
+cc_version = pkg_version("cloudmesh-ee")
 
 rtd = True
 # rtd = False
 
-sys.path.insert(0, os.path.abspath('..'))
-# sys.path.insert(0, os.path.abspath('../../cloudmesh'))
+sys.path.insert(0, os.path.abspath('../../src'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 
 numfig = True
@@ -26,7 +27,7 @@
 
 
 project = 'cloudmesh-ee'
-copyright = '2022, Gregor von Laszewski'
+copyright = '2025, Gregor von Laszewski'
 author = 'Gregor von Laszewski'
 release = cc_version
 
@@ -48,7 +49,7 @@
 extensions.append('sphinx_copybutton')
 
 #extensions.append('sphinx.ext.githubpages')
-#extensions.append('sphinx.ext.napoleon')
+extensions.append('sphinx.ext.napoleon')
 #extensions.append('sphinx.ext.todo')
 
 

docs/source/cloudmesh.ee.rst

@@ -13,3 +13,4 @@ mistune==0.8.4
 sphinxcontrib-openapi
 sphinx-copybutton
 sphinx_autodoc_typehints
+lxml[html_clean]