updating documentation

sandialabs · Mar 22, 2021 · 7a90214 · 7a90214
1 parent abba99b
commit 7a90214
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ pvOps contains a series of functions to facilitate fusion of text-based data wit
 
 Installation
 =============
-pvOps can be installed using `pip` or `conda`. See more information at [readthedocs](https://pvops.readthedocs.io/en/latest/).
+pvOps can be installed using `pip`. See more information at [readthedocs](https://pvops.readthedocs.io/en/latest/).
 
 
 Package Layout and Documentation

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -0,0 +1,18 @@
+.. _contributing:
+
+Contributing
+============
+
+Thank you for wanting to contribute to this library! We will try to make this an easy process for you.
+
+**If you find errors in the codebase:**
+
+1. Submit an issue at the `pvOps issues page <https://github.com/tgunda/pvOps/issues>`_
+
+**If you would like to contribute:**
+
+2. Create a pull request (PR) or help with other PRs which are in the library by referencing `pvOps PR page <https://github.com/tgunda/pvOps/pulls>`_. Pull requests should contain code that follows the PEP8 python code style.
+
+**If you are confused:**
+
+3. Feel free to reach out to the package maintainer, as found in setup.py. 
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,7 +16,8 @@ pvOps contains a series of functions to facilitate fusion of text-based data wit
 
 Installation
 =============
-pvOps can be installed using `pip` or `conda`.
+pvOps can be installed using `pip`.
+
 
 Text Subpackage Layout
 ======================

diff --git a/setup.py b/setup.py
@@ -9,13 +9,14 @@
                'field collected operational data for photovoltaic systems.')
 
 LONG_DESCRIPTION = """
-pvOps is a collection of functions for working with text-based data
+pvOps is a python package for PV operators & researchers. It is
+a collection of functions for working with text-based data
 from photovoltaic power systems. The library includes functions for
 processing text data as well as fusion of the text information with
 time series data for visualization of contextual details for data
 analysis. 
-Documentation: XX
-Source code: XX
+Documentation: https://pvops.readthedocs.io/en/latest/index.html
+Source code: https://github.com/tgunda/pvOps
 """
 
 DISTNAME = 'pvOps'