diff --git a/Makefile b/Makefile index d46d350c47..7515d21401 100644 --- a/Makefile +++ b/Makefile @@ -4,3 +4,6 @@ tutorials.md: tutorials.py tutorials_header.md build/doc/tutorials/Readme.md python3 "$<" + +videos.md: videos.py videos_header.md build/doc/tutorials/Readme.md + python3 "$<" diff --git a/index.md b/index.md index 98d9aea5d0..9950bed453 100644 --- a/index.md +++ b/index.md @@ -11,6 +11,7 @@ $endif$ $if(latest_release)$ * For [ESPResSo $latest_release$](tutorials$latest_release$.html) $endif$ +* [Online videos](videos.html) # Development diff --git a/videos.py b/videos.py new file mode 100644 index 0000000000..b138d6e75c --- /dev/null +++ b/videos.py @@ -0,0 +1,37 @@ +# +# Copyright (C) 2021 The ESPResSo project +# +# This file is part of ESPResSo. +# +# ESPResSo is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# ESPResSo is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +""" +This script generates the landing page for video lectures. +""" + +marker_begin = '[comment]: # (Begin of videos landing page)' +marker_end = '[comment]: # (End of videos landing page)' + +with open('build/doc/tutorials/Readme.md') as f: + content = f.read() + +assert marker_begin in content, f'Readme.md is missing "{marker_begin}"' +assert marker_end in content, f'Readme.md is missing "{marker_end}"' +video_descriptions = content.split(marker_begin)[1].split(marker_end)[0] + +with open('videos_header.md', 'r') as f: + video_header = f.read() + +with open('videos.md', 'w') as f: + f.write(video_header + video_descriptions) diff --git a/videos_header.md b/videos_header.md new file mode 100644 index 0000000000..8cf07502e3 --- /dev/null +++ b/videos_header.md @@ -0,0 +1,5 @@ +# Online videos + +Video lectures about **ESPResSo** are available on YouTube. +Follow [ESPResSo Simulation Package](https://www.youtube.com/channel/UC6yzqhq2KrT-aDhPjcL-VNw/) +channel to get the latest updates!