resolve issues in docs

Author: wangcj05

.github/workflows/github-actions.yml

@@ -92,35 +92,3 @@ jobs:
           python -m coreferee install en
           python -m nltk.downloader all
 
-
-
-
-  # Test-DACKAR-Windows:
-  #   runs-on: windows-latest
-  #   steps:
-  #     - uses: conda-incubator/setup-miniconda@v3
-  #       with:
-  #         miniconda-version: "latest"
-  #         channels: conda-forge, defaults
-  #         use-only-tar-bz2: true  # IMPORTANT: This needs to be set for caching to work properly!
-  #         activate-environment: dackar_libs
-  #         auto-update-conda: true
-  #         auto-activate-base: false
-  #     - run: echo " The job was automatically triggered by a ${{ github.event_name }} event."
-  #     - run: echo " This job is now running on a ${{ runner.os }} server"
-  #     - run: echo " The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
-  #     - name: Check out repository code
-  #       uses: actions/checkout@v3
-  #     - run: pwd
-  #     - run: |
-  #         echo " Create dackar_libs"
-  #         conda create -n dackar_libs python=3.11
-  #         echo " Conda information"
-  #         conda info
-  #         echo " Activate Dackar conda environment"
-  #         conda init powershell
-  #         $CONDA/bin/activate dackar_libs
-  #         pip install spacy==3.5 textacy matplotlib nltk coreferee beautifulsoup4 networkx pysbd tomli numerizer autocorrect pywsd openpyxl quantulum3[classifier] numpy==1.26 scikit-learn pyspellchecker contextualSpellCheck pandas
-  #         python3 -m spacy download en_core_web_lg
-  #         python3 -m coreferee install en
-  #         python3 -m nltk.downloader all

.github/workflows/sphinx.yml

@@ -15,8 +15,9 @@ jobs:
         channels: conda-forge, defaults
         use-only-tar-bz2: true  # IMPORTANT: This needs to be set for caching to work properly!
         auto-update-conda: true
-        auto-activate-base: true
-    - run: conda install -c conda-forge pandoc
+        activate-environment: dackar_libs
+        auto-activate-base: false
+    - run: conda install -c conda-forge pandoc python=3.11
     - name: Build HTML
       uses: ammaraskar/sphinx-action@master
     - name: Upload artifacts

docs/conf.py

@@ -29,19 +29,20 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.intersphinx',
-	'sphinx.ext.autodoc',
+extensions = [
+    "sphinx.ext.napoleon",  # <- For Google style docstrings
+    'sphinx.ext.intersphinx',
 	'sphinx.ext.doctest',
 	'sphinx.ext.todo',
 	"sphinx.ext.autodoc.typehints",
 	"sphinx.ext.mathjax",
     "sphinx.ext.autosummary",
 	"nbsphinx",  # <- For Jupyter Notebook support
-	"sphinx.ext.napoleon",  # <- For Google style docstrings
 	"sphinx.ext.imgmath",
 	"sphinx.ext.viewcode",
 	'autoapi.extension',
     'sphinx_copybutton',
+    'sphinx.ext.autodoc',
 ]
 
 templates_path = ['_templates']

src/dackar/utils/mbse/LMLparser.py

@@ -41,10 +41,13 @@ def LMLparser(self, diagramName):
     """
       This method is designed to parse the xml file containing the MBSE model, to create its corresponding graph
       and to populate:
-      - the set of entities: dictionary of assets in the form of 'LML_ID': ('asset name', 'asset ID')
-      - the set of links: list containing the LML-IDs of all links between assets
-      - the set of embedded entities: dictionary of the components that have been specified in the description text of the
-                                      LML asset or link (e.g., [comp1,comp2,comp3]) in the form of 'LML_ID': [comp1,comp2,comp3]
+
+      * the set of entities: dictionary of assets in the form of 'LML_ID': ('asset name', 'asset ID')
+
+      * the set of links: list containing the LML-IDs of all links between assets
+
+      * the set of embedded entities: dictionary of the components that have been specified in the description text of the
+        LML asset or link (e.g., [comp1,comp2,comp3]) in the form of 'LML_ID': [comp1,comp2,comp3]
 
       Args:
 
@@ -99,8 +102,8 @@ def parseLinkEntity(self, linkNode):
 
       Args:
 
-        linkNode: xml node, xml node containing containing all the information of a single link generated
-                            in LML using Innoslate
+          linkNode: xml node, xml node containing containing all the information of a single link generated
+          in LML using Innoslate
 
       Returns:
 
@@ -130,8 +133,8 @@ def parseAssetEntity(self, entityNode):
 
       Args:
 
-        linkNode: xml node, xml node containing containing all the information of a single link generated
-                            in LML using Innoslate
+          linkNode: xml node, xml node containing containing all the information of a single link generated
+          in LML using Innoslate
 
       Returns:
 
@@ -202,8 +205,8 @@ def returnEntities(self):
 
       Returns:
 
-        self.entities     : dict, dict of entities
-        self.embEntities : dict, dict of embedded entities
+          self.entities     : dict, dict of entities
+          self.embEntities : dict, dict of embedded entities
     """
     return self.entities, self.embEntities
 
@@ -323,9 +326,9 @@ def parseEntityDescription(text):
 
     Returns:
 
-      out     : tuple, tuple containing the list of elements specified in square brackets and separated
-                      by commas (e.g., ['FV304,'305']) and the link to an external MBSE model
-                      (e.g., ('centrifugalPumpFull', 'body'))
+        out: tuple, tuple containing the list of elements specified in square brackets and separated
+        by commas (e.g., ['FV304,'305']) and the link to an external MBSE model
+        (e.g., ('centrifugalPumpFull', 'body'))
 
   """