Source files for the TU Delft Special Topics in Sports Engineering Course
CC-BY-4.0 License
The course website for Delft University of Technology's Special Topics in Sports Engineering course. The rendered version can be viewed at:
http://moorepants.github.io/me41035
Pelican documentation
_ tomaster
. This is the defaultgh-pages
branch, which is automatically served togh-pages
branch.Sphinx reStructuredText primer
_ to learn themaster
branch... _Pelican documentation: http://docs.getpelican.com/en/stable/ .. _Sphinx reStructuredText primer: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
It is good practice to build the documentation locally so that you can review change before submitting a pull request.
Install pelican with conda (or pip if you prefer)::
$ conda install pelican pyyaml
Clone the theme repository (make sure to use the mechmotum
branch)::
$ git clone --branch mechmotum [email protected]:mechmotum/pelican-alchemy.git
Note the path to the theme, e.g.::
/home/my_username/.../pelican-alchemy/alchemy
Clone the pelican-plugins repository::
$ git clone [email protected]:getpelican/pelican-plugins.git
Note the path to the plugins directory, e.g.::
/home/my_username/.../pelican-plugins
Clone this repository and change into the new directory::
$ git clone [email protected]:moorepants/me41035.git $ cd me41035/
Create a configuration file called config.yml
and add the full path to
where you installed the theme::
$ echo "THEME_PATH: /home/my_username/.../pelican-alchemy/alchemy" > config.yml $ echo "PLUGIN_PATHS: /home/my_username/.../pelican-plugins" >> config.yml
Now you can build and serve the documentation with::
$ make devserver
If this succeeds you can open the website in your web browser at http://localhost:8000.
While the server is running you can change the website source files and they will be build automatically. Refresh your web browser to view the changes.
To stop the web server press <CTRL + C> or type make stopserver
.
This repository is licensed under the CC-BY 4.0 license.