auto_api and documentation improvement

both an auto _ api and a manual_api, which so far only has bifacial_radiance.main file in it, with classes AnalysisObj, GroundObj, MetObj finished and some out of RadianceOBj improved, but 192 errors to gooooooooooooooooooo !!!!! But interested to see if this improves the readthedocs.io page But I'm
NREL · Oct 3, 2019 · c6647c8 · c6647c8
1 parent 2bca188
commit c6647c8
Show file tree

Hide file tree

Showing 10 changed files with 944 additions and 348 deletions.
diff --git a/bifacial_radiance/main.py b/bifacial_radiance/main.py
diff --git a/docs/sphinx/source/.contributing.rst.un~ b/docs/sphinx/source/.contributing.rst.un~
diff --git a/docs/sphinx/source/.index.rst.un~ b/docs/sphinx/source/.index.rst.un~
diff --git a/docs/sphinx/source/.manualapi.rst.un~ b/docs/sphinx/source/.manualapi.rst.un~
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -65,11 +65,19 @@ def __getattr__(cls, name):
     'sphinx.ext.napoleon',
     'sphinx.ext.autosummary',
     'IPython.sphinxext.ipython_directive',
-    'IPython.sphinxext.ipython_console_highlighting'
+    'IPython.sphinxext.ipython_console_highlighting',
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'autoapi.extension'
 ]
 
-napoleon_use_rtype = False  # group rtype on same line together with return
+autodoc_mock_imports = ['bs4', 'requests']
+
+# Document Python Code
+autoapi_type = 'python'
+autoapi_dirs = '../../../bifacial_radiance'
 
+napoleon_use_rtype = False  # group rtype on same line together with return
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/sphinx/source/contributing.rst~ b/docs/sphinx/source/contributing.rst~
diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst
@@ -12,7 +12,7 @@ The source code for bifacial_radiance is hosted on `github
 Please see the :ref:`installation` page for installation help.
 
 For examples on how to use bifacial_radiance, please see :ref:`package_overview` and our `Jupyter Notebook tutorials
-<http://github.com/Nrel/bifacial_radiance/docs/tutorails/>`_. The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages.
+<http://github.com/Nrel/bifacial_radiance/docs/tutorials/>`_. The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages.
 
 The bifacial_radiance GitHub wiki has a `Projects and publications that use bifacial_radiance <https://github.com/NREL/bifacial_radiance/wiki/>`_ page for inspiration and listing of your application.
 
@@ -41,10 +41,11 @@ Contents
 ========
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    modelchain
    contributing
+   manualapi
 
 Indices and tables
 ==================

diff --git a/docs/sphinx/source/index.rst~ b/docs/sphinx/source/index.rst~
@@ -0,0 +1,54 @@
+.. image:: ../../images_wiki/bifacial_radiance.png
+  :width: 600
+
+Welcome to bifacial_radiance's documentation!
+=============================================
+
+bifacial_radiance is a NREL supported tool that provides a set of functions and classes for simulating the performance of bifacial PV systems. More information on bifacial_radiance can be found at the Wiki page.
+
+The source code for bifacial_radiance is hosted on `github
+<https://github.com/NREL/bifacial_radiance>`_.
+
+Please see the :ref:`installation` page for installation help.
+
+For examples on how to use bifacial_radiance, please see :ref:`package_overview` and our `Jupyter Notebook tutorials
+<http://github.com/Nrel/bifacial_radiance/docs/tutorials/>`_. The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages.
+
+The bifacial_radiance GitHub wiki has a `Projects and publications that use bifacial_radiance <https://github.com/NREL/bifacial_radiance/wiki/>`_ page for inspiration and listing of your application.
+
+There is a :ref:`variable naming convention <variables_style_rules>` to 
+ensure consistency throughout the library
+
+Citing bifacial_radiance
+========================
+
+Many of the contributors to bifacial_radiance work in institutions where
+citation metrics are used in performance or career evaluations. If you
+use bifacial_radiance in a published work, please cite:
+
+ Something something something. Journal of Open Source Software,
+
+Please also cite the DOI corresponding to the specific version of
+bifacial_radiance that you used. bifacial_radiance DOIs are listed at
+`Zenodo.org`
+
+Additional pvlib python publicaitons include:
+
+ * Something something
+ * Something something
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   modelchain
+   contributing
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/sphinx/source/manualapi.rst b/docs/sphinx/source/manualapi.rst
@@ -0,0 +1,12 @@
+Bifacial-Radiance Python API
+============================
+
+This is an attempt to mannually populate the python api information from
+Bifacial_radiance
+
+bifacial_radiance.main
+----------------------
+
+.. automodule:: bifacial_radiance.main
+   :members:
+
diff --git a/docs/sphinx/source/manualapi.rst~ b/docs/sphinx/source/manualapi.rst~
@@ -0,0 +1,5 @@
+bifacial_radiance.main
+
+.. automodule:: bifacial_radiance.main
+   :members:
+