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.

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

Adding Sphinx examples for each of the QA modules in the package. #133

Open
kperrynrel opened this issue Feb 18, 2022 · 2 comments · Fixed by #131
Open

Adding Sphinx examples for each of the QA modules in the package. #133

kperrynrel opened this issue Feb 18, 2022 · 2 comments · Fixed by #131
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kperrynrel
Copy link
Member

kperrynrel commented Feb 18, 2022

Add Sphinx documentation to illustrate the value of each of the following modules, in order:

-clipping
-Data gaps (gaps module)
-Outlier detection and removal (outliers)
-Irradiance
-Day-night masking

Include example data for these modules in the /data/ folder.

@kperrynrel kperrynrel self-assigned this Feb 18, 2022
@kandersolar
Copy link
Member

May be better to have one example per function instead of one example per module to keep them from getting overly lengthy. Also, we're not using it currently, but it's easy to configure sphinx-gallery to organize examples by topic.

@kperrynrel
Copy link
Member Author

Additional modules to add documentation for:
-orientation
-shading
-weather
-metrics

@kperrynrel kperrynrel added the documentation Improvements or additions to documentation label Mar 30, 2022
@kperrynrel kperrynrel linked a pull request Jul 1, 2022 that will close this issue
4 tasks
@kperrynrel kperrynrel mentioned this issue Jul 6, 2022
8 tasks
@kperrynrel kperrynrel reopened this Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants