behnam-zakeri / ece-teaching

Overview of the teaching & learning material by the ECE program

Copyright (c) 2021 IIASA; published under the MIT License

This is a Sphinx project for the documentation of the teaching and learning activities by the Energy, Climate, and Environment Program (ECE). The website can be found here.

The MIT license applies only to this site and not to the teaching and learning content.

Scope & Aim

This repository contains pages with relevant information about teaching events, including links to relevant websites and the teaching material (e.g., pdf, pptx, recorded videos). Any such material should not be committed to this repository, but be stored in an appropriate location such as the IIASA publication repository (pure.iiasa.ac.at) or a personal folder, e.g., https://data.ece.iiasa.ac.at/

The material comprises workshops organized by ECE, university courses taught by ECE staff, tutorials, etc.

Instructions

How to install dependencies and build locally

1. Install dependencies:

   In the local copy of the ece-teaching repository, run pip install -r requirements.txt

2. Build from the command line. On Linux or macOS:

   make html

   On Windows:

   .\make html

3. Open the rendered html page to see if everything fits:

   _build/html/index.html

How to add new content

1. Fork the repository.

2. Create a new branch.

3. Update

   a) either the existing ReST file index.rst or,

   b) implement your ReST file on the top level.

4. If you created a new ReST file, add the path of your ReST file in the hidden TOC and reference it with :doc:... under the respective section. See the following example for adding other Workshop and tutorial material.

   .. toctree::
      :hidden:
      :maxdepth: 1
      :caption: Workshops and tutorials
   
      message_ix_workshop
      your_file_path
   
   - :doc:`message_ix_workshop`
   - :doc:`your_file_path`
   
   

5. Create a PR to the main branch of iiasa/ece-teaching with yourself as an assignee and a reviewer.

How to write

Use the following references for writing your ReST file:

• Quick reStructuredText reference from docutils.
• ReST cheat sheet by Thomas Cokelaer.
• Sphinx documentation, including reference on Sphinx-specific ReST syntax.

See the following example on how to link e.g. your video from the IIASA publication repository (pure.iiasa.ac.at) or a folder on ldom002.

.. raw:: html

	<video width="640" height="360" controls preload="none" controlsList="nodownload">
		<source src="Your file path" type="video/mp4">