Skip to content

Commit 4bd9f2f

Browse files
authored
Update docs tools slides and demos (#211)
* Update docs tools slides and demos * Fix md formatting
1 parent ad21b0d commit 4bd9f2f

File tree

6 files changed

+15
-7
lines changed

6 files changed

+15
-7
lines changed

04_documentation/examples/pandoc/example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: My awesome title
33
author: Firstname lastname
4-
date: 2023-01-13
4+
date: 2025-01-08
55
---
66

77
# Introduction

04_documentation/examples/reStructuredText-example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Code uses backticks. This can be code/variable names in text that ``appear`` in
4141
}
4242

4343
..
44-
Quotations can be by indenting them more than surronding. We use an empty comment ``..`` in order to separate the code block from this quote.
44+
Quotations work by indenting them more than the surrounding. We use an empty comment ``..`` in order to separate the code block from this quote.
4545
4646
We can also have hyperlinks to other websites. We could link to the `course website`_, but separate the link and target definition.
4747

04_documentation/markup_languages_slides.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,6 @@ From [YAML website](https://yaml.org/)
199199
- Popular for configurations
200200
- Indentation with **two** spaces is important.
201201
- Tabs **not** allowed for indentation
202-
- Can differentiate between datatypes
203202
- Recommended file extension `yaml` (also `yml`)
204203

205204
---

04_documentation/pandoc_demo.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
- Color link: `pandoc example.md -V colorlinks -o example.pdf`
2929
- Binary option, no value
3030
- Find `colorlinks` in `template.tex`
31+
- [All variables for LaTeX](https://pandoc.org/MANUAL.html#variables-for-latex)
3132

3233
## Custom Templates
3334

04_documentation/website_generators_demo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Example code is in [`04_documentation/examples/sphinx`](https://github.com/Simul
5454
+.. include:: ../README.rst
5555
```
5656

57-
- Look at `conf.py` and change style to `classic`
57+
- Look at `conf.py` and change theme to `classic`
5858

5959
## Code Documentation
6060

04_documentation/website_generators_slides.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ slideOptions:
6161
## Brief Overview of Tools
6262

6363
- General documentation site generators
64-
- [MkDocs](https://www.mkdocs.org) (md), [Sphinx](https://www.sphinx-doc.org/en/master/) (rst), [jekyll](https://jekyllrb.com/), ...
64+
- [MkDocs](https://www.mkdocs.org) (md), [Sphinx](https://www.sphinx-doc.org/en/master/) (rst), [jekyll](https://jekyllrb.com/), [Hugo](https://gohugo.io/), ...
6565
- Code documentation site generators
6666
- [Doxygen](https://www.doxygen.nl) (C++, C...), Sphinx with [autodoc extension](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) (Python), ...
6767
- Publishing tools
@@ -74,6 +74,14 @@ slideOptions:
7474

7575
---
7676

77+
## HIWI Wanted
78+
79+
- Migrate preCICE website generator from jekyll to Hugo
80+
- Pitfalls with current setup: [issue 471](https://github.com/precice/precice.github.io/issues/471)
81+
- Migration: [issue 472](https://github.com/precice/precice.github.io/issues/472)
82+
83+
---
84+
7785
## Step by Step Plan
7886

7987
1. Document Python code: docstrings
@@ -204,8 +212,8 @@ From [project homepage](https://readthedocs.org/)
204212

205213
## More Optional Homework: MkDocs + GitHub Pages
206214

207-
- Last year, we had a homework to document our *"yaml-cpp-dealii-boost code"* using MkDocs and publish on GitHub pages.
208-
- If you want to get a glimpse on these tools, follow the [exercise sheet](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/ab8476624c39c20198afbc5f9773775fad62785e/04_documentation/tools_exercise.md) from last year.
215+
- Previously, we had a homework to document our *"yaml-cpp-dealii-boost code"* using MkDocs and publish on GitHub pages.
216+
- If you want to get a glimpse on these tools, follow the [abandoned exercise sheet](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/ab8476624c39c20198afbc5f9773775fad62785e/04_documentation/tools_exercise.md).
209217

210218
---
211219

0 commit comments

Comments
 (0)