Merge pull request #144 from NREL/documentation_fix

bug fix on documentation
NREL · Mar 25, 2024 · af59324 · af59324
2 parents 9f92231 + 3d7f420
commit af59324
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 24 deletions.
diff --git a/.github/workflows/pull_request_tests.yml b/.github/workflows/pull_request_tests.yml
@@ -7,9 +7,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest]
+        #os: [ubuntu-latest, macos-latest]
           #os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9"] #["3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v2

diff --git a/docs/source/CLI interface.rst b/docs/source/CLI interface.rst
@@ -1,3 +1,5 @@
+CLI Interface
+^^^^^^^^^^^^^
 
 .. click:: pydss.cli.pydss:cli
    :prog: Command line interface

diff --git a/docs/source/_autosummary/PyDSS.api.server.rst b/docs/source/_autosummary/PyDSS.api.server.rst
@@ -1,4 +1,4 @@
-pydss.api.server
+pydss.api.server
 ================
 
 .. automodule:: pydss.api.server

diff --git a/docs/source/_autosummary/PyDSS.api.src.web.handler.rst b/docs/source/_autosummary/PyDSS.api.src.web.handler.rst
@@ -1,4 +1,4 @@
-pydss.api.src.web.handler
+pydss.api.src.web.handler
 =========================
 
 .. automodule:: pydss.api.src.web.handler

diff --git a/docs/source/_autosummary/PyDSS.cli.pydss.rst b/docs/source/_autosummary/PyDSS.cli.pydss.rst
@@ -1,4 +1,4 @@
-pydss.cli.pydss
+pydss.cli.pydss
 ===============
 
 .. automodule:: pydss.cli.pydss

diff --git a/docs/source/_autosummary/PyDSS.cli.run_server.rst b/docs/source/_autosummary/PyDSS.cli.run_server.rst
@@ -1,4 +1,4 @@
-pydss.cli.run\_server
+pydss.cli.run\_server
 =====================
 
 .. automodule:: pydss.cli.run_server

diff --git a/docs/source/_autosummary/PyDSS.pydss_fs_interface.rst b/docs/source/_autosummary/PyDSS.pydss_fs_interface.rst
@@ -19,7 +19,6 @@ pydss.pydss\_fs\_interface
 
       PyDssArchiveFileInterfaceBase
       PyDssFileSystemInterface
-      PyDssFileSystemInterface
       PyDssTarFileInterface
       PyDssZipFileInterface
 

diff --git a/docs/source/_autosummary/PyDSS.rst b/docs/source/_autosummary/PyDSS.rst
@@ -1,4 +1,5 @@
-Pydss
+
+Pydss
 =====
 
 .. automodule:: pydss

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,12 +36,12 @@ def find_version(*file_paths):
         return version_match.group(1)
     raise RuntimeError("Unable to find version string.")
 
-project = 'PyDSS'
+project = 'Pydss'
 copyright = '2019, Aadil Latif'
 author = 'Aadil Latif'
 
 # The full version, including alpha/beta/rc tags
-release = find_version("../../PyDSS", "__init__.py")
+release = find_version("../../src/pydss", "__init__.py")
 
 # -- General configuration ---------------------------------------------------
 
@@ -91,7 +91,7 @@ def find_version(*file_paths):
 
 redoc = [
     {
-        'name': 'PyDSS API',
+        'name': 'Pydss API',
         'page': 'api',
         'spec': 'spec/swagger.yml',
         'embed': True,

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,18 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. figure::  _static/Logo.png
-   :align:   center
-
 #####
 Pydss
 #####
 
 ***********
-About PyDSS
+About Pydss
 ***********
 
-PyDSS is a Python wrapper for OpenDSS that aims to expand upon its
+Pydss is a Python wrapper for OpenDSS that aims to expand upon its
 organizational, analytical, and visualization capabilities with these features:
 
 - Allows the user to develop custom control algorithms for specific circuit elements and run them
@@ -25,7 +22,7 @@ organizational, analytical, and visualization capabilities with these features:
 - Automates collection and analysis of circuit element results at each simulation time step.
 - Flexible architecture allows users to develop extensions.
 
-PyDSS uses opendssdirect.py (https://pypi.org/project/OpenDSSDirect.py/) to communicate with
+Pydss uses opendssdirect.py (https://pypi.org/project/OpenDSSDirect.py/) to communicate with
 OpenDSS.
 
 .. _installation_label:
@@ -43,18 +40,12 @@ Here is an example conda command:
 
     $ conda create -n pydss python=3.9
 
-Install shapely with conda. pip, particularly on Windows, often fails to install its dependent
-libraries.
-
-.. code-block:: bash
-
-    $ conda install shapely
 
 Install the latest supported pydss version with this command:
 
 .. code-block:: bash
 
-    $ pip install dsspy
+    $ pip install NREL-pydss
 	
 Alternatively, to get the lastest code from the master branch: