diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 3cdee5cf..56671a87 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -47,9 +47,13 @@ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'nbsphinx', - 'sphinxcontrib.napoleon' + 'sphinxcontrib.napoleon', + 'sphinxcontrib_github_alt' ] +# For sphinxcontrib_github_alt +github_project_url = "https://github.com/SunPower/pvfactors" + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/sphinx/whatsnew.rst b/docs/sphinx/whatsnew.rst index 11fea062..77a811d9 100644 --- a/docs/sphinx/whatsnew.rst +++ b/docs/sphinx/whatsnew.rst @@ -6,6 +6,7 @@ What's New These are new features and improvements of note in each release. +.. include:: whatsnew/v1.0.0.rst .. include:: whatsnew/v0.1.5.rst .. include:: whatsnew/v0.1.4.rst .. include:: whatsnew/v0.1.3.rst diff --git a/docs/sphinx/whatsnew/v1.0.0.rst b/docs/sphinx/whatsnew/v1.0.0.rst new file mode 100644 index 00000000..85e62db7 --- /dev/null +++ b/docs/sphinx/whatsnew/v1.0.0.rst @@ -0,0 +1,26 @@ +.. _whatsnew_1000: + +v1.0.0 (April 19, 2019) +======================= + +Major release for pvfactors. The whole code base was revamped, which led to a 5x speed increase in computational speed. The package API has now also been completely upgraded, with a seperation and uncoupling between geometry, irradiance, and view factor modeling. All of these items are now unified into an engine and also some run functions to run full or partial simulations, and inspect the results. +The documentation was completely revamped as well, with a new tutorial section containing lots of examples to get familiar with pvfactors, and also a developer API section that documents all of the classes and functions of the package. + +* Fix pvlib version in order to create conda build (#26) +* Update docs: reorganize, clean up, and add API (#27) +* Fix img url and update circleci look (#28) +* New Geometry API (#29) +* API refactoring for view factor calculation (#30) +* New irradiance API (#31) +* Implement perez model with new irradiance API (#33) +* Implement engine to run simulations using new APIs (#32) +* Implement functional run and parallel computation (#37) +* Migrate last elements to new API (#38) +* Remove old API files (#39) +* Update docs for new pvfactors API (#40) +* Update docstrings (#41) + +Contributors +------------ + +* Marc Anoma (:ghuser:`anomam`) diff --git a/setup.py b/setup.py index 505a81ac..e0e25395 100644 --- a/setup.py +++ b/setup.py @@ -45,7 +45,7 @@ extras_require={ 'testing': TESTS_REQUIRES, 'docs': ['Sphinx', 'sphinx_rtd_theme', 'nbsphinx', - 'sphinxcontrib-napoleon'] + 'sphinxcontrib-napoleon', 'sphinxcontrib_github_alt'] }, license=LICENSE )