Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[JOSS review] Updates to the documentation #74

Merged
merged 3 commits into from
Oct 5, 2023
Merged

[JOSS review] Updates to the documentation #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e676b1
Update index.rst
AdamRJensen Sep 12, 2023
b7abc74
Remove boilerplate info (not useful)
AdamRJensen Sep 12, 2023
6554a55
Update .gitignore
AdamRJensen Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ docs/_build/
.pytest_cache/
*.py[cod]
examples/analysis/
examples/.ipynb_checkpoints/
*.ipynb_checkpoints/
*~
pvops/.vscode/*
pvops/text2time/.vscode
Expand Down
11 changes: 2 additions & 9 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
Overview
============
pvops is a python package for PV operators & researchers.
It consists a set of documented functions for supporting operations
research of photovoltaic energy systems.
It consists of a set of documented functions for supporting operations
research of photovoltaic (PV) energy systems.
The library leverages advances in machine learning, natural
language processing and visualization
tools to extract and visualize actionable information from common
Expand Down Expand Up @@ -54,10 +54,3 @@ production data, and current-voltage (IV) curves.
pages/contributing
pages/releasenotes


Indices and tables
-------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
15 changes: 0 additions & 15 deletions docs/pages/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,6 @@ to be parsed and displayed correctly. For an example of what this should look li

Additional examples can be found in the
`napoleon documentation <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html>`_.
The following boilerplate can be copy-pasted into the top of a function definition
to help get things started::

"""Summary line.

Extended description of function.

Parameters
----------

Returns
-------


"""

Extending Documentation
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
Loading