bjoern/pypsa-eur
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

doc: fix tutorial video embedding [skip travis]

Browse Source
This commit is contained in:
Fabian Neumann 2020-05-28 21:30:10 +02:00
parent a41e6a2ff5
commit 6bde6e52de
5 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/conf.py
View File

@ -37,8 +37,6 @@ extensions = [
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.graphviz', 'sphinx.ext.graphviz',
'sphinxcontrib.youtube',
'sphinxcontrib.slide',
#'sphinx.ext.pngmath', #'sphinx.ext.pngmath',
#'sphinxcontrib.tikz', #'sphinxcontrib.tikz',
#'rinoh.frontend.sphinx', #'rinoh.frontend.sphinx',

2
doc/installation.rst
View File

@ -55,7 +55,7 @@ The environment can be installed and activated using
and then install the environment with and then install the environment with
.. coda:: bash .. code:: bash
mamba env create -f environment.yaml mamba env create -f environment.yaml

6
doc/introduction.rst
View File

@ -4,9 +4,11 @@
Introduction Introduction
########################################## ##########################################
.. youtube:: ty47YU1_eeQ .. raw:: html
.. slide:: https://docs.google.com/presentation/d/e/2PACX-1vQGQZD7KIVdocRZzRVu8Uk-JC_ltEow5zjtIarhyws46IMJpaqGuux695yincmJA_i5bVEibEs7z2eo/pub?start=false&loop=true&delayms=3000 <iframe width="832" height="468" src="https://www.youtube.com/embed/ty47YU1_eeQ" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Find the introductory slides `here <https://docs.google.com/presentation/d/e/2PACX-1vQGQZD7KIVdocRZzRVu8Uk-JC_ltEow5zjtIarhyws46IMJpaqGuux695yincmJA_i5bVEibEs7z2eo/pub?start=false&loop=true&delayms=3000>`_.
Workflow Workflow
========= =========

10
doc/tutorial.rst
View File

@ -1,10 +1,16 @@
..
SPDX-FileCopyrightText: 2016-2019 The Atlite Authors
SPDX-License-Identifier: CC-BY-4.0
.. _tutorial: .. _tutorial:
##################### #####################
Tutorial Tutorial
##################### #####################
.. youtube:: mAwhQnNRIvs .. raw:: html
<iframe width="832" height="468" src="https://www.youtube.com/embed/mAwhQnNRIvs" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Before getting started with **PyPSA-Eur** it makes sense to be familiar Before getting started with **PyPSA-Eur** it makes sense to be familiar
with its general modelling framework `PyPSA <https://pypsa.readthedocs.io>`_. with its general modelling framework `PyPSA <https://pypsa.readthedocs.io>`_.
@ -40,7 +46,7 @@ The model can be adapted to only include selected countries (e.g. Germany) inste
.. literalinclude:: ../config.tutorial.yaml .. literalinclude:: ../config.tutorial.yaml
:language: yaml :language: yaml
:lines: 15 :lines: 16
Likewise, the example's temporal scope can be restricted (e.g. to a single month). Likewise, the example's temporal scope can be restricted (e.g. to a single month).

3
environment.docs.yaml
View File

@ -50,6 +50,3 @@ dependencies:
- cdsapi - cdsapi
- sphinx - sphinx
- sphinx_rtd_theme - sphinx_rtd_theme
- sphinxcontrib-youtube
- sphinxcontrib-slide
- urlparse