Imporving documentation

Author: PRadatz

CHANGELOG.rst

@@ -2,6 +2,12 @@
 Changelog
 =========
 
+0.0.1 (2020-06-12)
+------------------
+
+* Integrating CI 
+
+
 0.0.0 (2020-06-12)
 ------------------
 

CONTRIBUTING.rst

@@ -30,61 +30,4 @@ If you are proposing a feature:
 
 * Explain in detail how it would work.
 * Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
-
-Development
-===========
-
-To set up `py_dss_interface` for local development:
-
-1. Fork `py_dss_interface <https://github.com/PauloRadatz/py_dss_interface>`_
-   (look for the "Fork" button).
-2. Clone your fork locally::
-
-    git clone [email protected]:PauloRadatz/py_dss_interface.git
-
-3. Create a branch for local development::
-
-    git checkout -b name-of-your-bugfix-or-feature
-
-   Now you can make your changes locally.
-
-4. When you're done making changes run all the checks and docs builder with `tox <https://tox.readthedocs.io/en/latest/install.html>`_ one command::
-
-    tox
-
-5. Commit your changes and push your branch to GitHub::
-
-    git add .
-    git commit -m "Your detailed description of your changes."
-    git push origin name-of-your-bugfix-or-feature
-
-6. Submit a pull request through the GitHub website.
-
-Pull Request Guidelines
------------------------
-
-If you need some code review or feedback while you're developing the code just make the pull request.
-
-For merging, you should:
-
-1. Include passing tests (run ``tox``) [1]_.
-2. Update documentation when there's new API, functionality etc.
-3. Add a note to ``CHANGELOG.rst`` about the changes.
-4. Add yourself to ``AUTHORS.rst``.
-
-.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
-       `run the tests <https://travis-ci.org/PauloRadatz/py_dss_interface/pull_requests>`_ for each change you add in the pull request.
-
-       It will be slower though ...
-
-Tips
-----
-
-To run a subset of tests::
-
-    tox -e envname -- pytest -k test_myfeature
-
-To run all the test environments in *parallel* (you need to ``pip install detox``)::
-
-    detox
+* Remember that this is a volunteer-driven project, and that code contributions are welcome :)

README.rst

@@ -70,11 +70,6 @@ Installation
 
     pip install py-dss-interface
 
-You can also install the in-development version with::
-
-    pip install https://github.com/PauloRadatz/py_dss_interface/archive/master.zip
-
-
 Documentation
 =============
 

docs/index.rst

@@ -8,7 +8,7 @@ Contents
    readme
    installation
    usage
-   reference/index
+   modules
    contributing
    authors
    changelog

docs/modules.rst

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   py_dss_interface

docs/py_dss_interface.rst

@@ -0,0 +1,22 @@
+py\_dss\_interface package
+==========================
+
+Submodules
+----------
+
+py\_dss\_interface.DSS module
+-----------------------------
+
+.. automodule:: py_dss_interface.DSS
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: py_dss_interface
+   :members:
+   :undoc-members:
+   :show-inheritance:

src/py_dss_interface/DSS.py

@@ -11,6 +11,10 @@
 class DSSDLL:
 
     def __init__(self, dll_folder=None):
+        """
+        Class to create an OpenDSS object
+        :param dll_folder: None will use the OpenDSS available within the package. The DDLL path allows to use a different OpenDSS
+        """
 
         if dll_folder == None:
             script_path = os.path.dirname(os.path.abspath(__file__))
@@ -19,7 +23,6 @@ def __init__(self, dll_folder=None):
         self.opendss_started = False
 
         if platform.architecture()[0] == "64bit":
-
             try:
                 os.chdir(os.path.join(dll_folder, "64"))
                 self.dssObj = ctypes.WinDLL("OpenDSSDirect.dll")
@@ -45,7 +48,6 @@ def __init__(self, dll_folder=None):
             # print("OpenDSS Failed to Start")
 
     def _allocate_memory(self):
-
         self.dssObj.ActiveClassS.restype = ctypes.c_char_p
 
         self.dssObj.BUSF.restype = ctypes.c_double