Skip to content

Commit 29d03fc

Browse files
kandersolarkandersolar
committed
first attempt
0 parents  commit 29d03fc

9 files changed

+202
-0
lines changed

‎.github/workflows/sphinx-build-deploy.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: deploy-book
2+
3+
# Only run this when the main branch changes
4+
on:
5+
push:
6+
branches:
7+
- main
8+
9+
# This job installs dependencies, build the book, and pushes it to `gh-pages`
10+
jobs:
11+
deploy-book:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
16+
# Install dependencies
17+
- name: Set up Python 3.9
18+
uses: actions/setup-python@v1
19+
with:
20+
python-version: 3.9
21+
22+
- name: Install dependencies
23+
run: |
24+
pip install -r requirements.txt
25+
- name: Build the book
26+
run: |
27+
make html
28+
- name: GitHub Pages action
29+
uses: peaceiris/[email protected]
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_dir: ./build/html

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build

‎Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx==4.5.0
2+
pydata-sphinx-theme==0.8.1
3+
sphinx-design==0.3.0

‎source/_static/pvsc-48-logo-cropped.png

66.2 KB
Loading

‎source/_static/pydata-2021-logo-cropped.png

23.2 KB
Loading

‎source/conf.py

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'pvlib tutorials'
10+
copyright = '2022, pvlib community'
11+
author = 'pvlib community'
12+
13+
# -- General configuration ---------------------------------------------------
14+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
15+
16+
extensions = ["sphinx_design"]
17+
18+
templates_path = ['_templates']
19+
exclude_patterns = []
20+
21+
22+
23+
# -- Options for HTML output -------------------------------------------------
24+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
25+
26+
html_theme = 'pydata_sphinx_theme'
27+
html_static_path = ['_static']
28+
29+
# disable the useless empty left sidebar
30+
html_sidebars = {
31+
"**": []
32+
}

‎source/index.rst

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
2+
This page links to tutorial material for `pvlib-python <pvlib-python.readthedocs.io>`_,
3+
a free and open-source python package for simulating photovoltaic power systems.
4+
These tutorials were created by pvlib contributors and community members as
5+
introductory material for newcomers to pvlib. They were originally developed
6+
to be presented in workshop-style interactive tutorials at conferences, but
7+
the material itself is still useful on its own.
8+
9+
If you have created a tutorial and want to have it listed on this page,
10+
feel free to submit it to this website's `git repository <https://github.com/PVSC-Python-Tutorials/pvsc-python-tutorials.github.io>`_.
11+
12+
13+
.. grid:: 1 2 3 3
14+
15+
.. grid-item-card:: PVPMC_2022
16+
17+
.. raw:: html
18+
19+
<img src="https://raw.githubusercontent.com/PVSC-Python-Tutorials/PVPMC_2022/main/images/PVLib_PVPMCLogo.PNG" alt="logo" loading="lazy" style="max-width: 100%; max-height: 200px; margin-top: 1rem;"/>
20+
21+
^^^
22+
23+
A pvlib tutorial given at the 2022 PVPMC workshop in Salt Lake City.
24+
25+
+++
26+
27+
:bdg-link-primary:`Repository <https://github.com/PVSC-Python-Tutorials/PVPMC_2022>`
28+
:bdg-link-primary:`Website <https://pvsc-python-tutorials.github.io/PVPMC_2022/index.html>`
29+
30+
.. raw:: html
31+
32+
<a href="https://github.com/PVSC-Python-Tutorials/PVPMC_2022">
33+
<img src="https://img.shields.io/github/stars/PVSC-Python-Tutorials/PVPMC_2022?style=social"/>
34+
</a>
35+
36+
37+
.. grid-item-card:: pyData-2021-Solar-PV-Modeling
38+
39+
.. raw:: html
40+
41+
<img src="_static/pydata-2021-logo-cropped.png" alt="logo" loading="lazy" style="max-width: 100%; max-height: 200px; margin-top: 1rem;"/>
42+
43+
^^^
44+
45+
A tutorial given at the 2021 PyData Global conference: *Data & Tools to Model PV Systems*
46+
47+
+++
48+
49+
:bdg-link-primary:`Repository <https://github.com/PVSC-Python-Tutorials/pyData-2021-Solar-PV-Modeling>`
50+
:bdg-link-primary:`Website <https://pvsc-python-tutorials.github.io/pyData-2021-Solar-PV-Modeling/index.html>`
51+
:bdg-link-primary:`Recording <https://www.youtube.com/watch?v=sweUakFg3I8>`
52+
53+
.. raw:: html
54+
55+
<a href="https://github.com/PVSC-Python-Tutorials/pyData-2021-Solar-PV-Modeling">
56+
<img src="https://img.shields.io/github/stars/PVSC-Python-Tutorials/pyData-2021-Solar-PV-Modeling?style=social"/>
57+
</a>
58+
59+
60+
.. grid-item-card:: PVSC48-Python-Tutorial
61+
62+
.. raw:: html
63+
64+
<img src="_static/pvsc-48-logo-cropped.png" alt="logo" loading="lazy" style="max-width: 100%; max-height: 200px; margin-top: 1rem;"/>
65+
66+
^^^
67+
68+
A tutorial given at PVSC48 in 2021: *Solar PV Resource Modeling 101: From Sun Position to AC Output*
69+
70+
+++
71+
72+
:bdg-link-primary:`Repository <https://github.com/PVSC-Python-Tutorials/PVSC48-Python-Tutorial>`
73+
:bdg-link-primary:`Website <https://pvsc-python-tutorials.github.io/PVSC48-Python-Tutorial/index.html>`
74+
75+
.. raw:: html
76+
77+
<a href="https://github.com/PVSC-Python-Tutorials/PVSC48-Python-Tutorial">
78+
<img src="https://img.shields.io/github/stars/PVSC-Python-Tutorials/PVSC48-Python-Tutorial?style=social"/>
79+
</a>

0 commit comments

Comments
 (0)