Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove introduction header from training init #1410

Merged
merged 1 commit into from
Nov 20, 2023
Merged

Remove introduction header from training init #1410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 1 addition & 3 deletions planemo/training/tutorial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,6 @@
"""

TUTO_HAND_ON_BODY_TEMPLATE = """
# Introduction

<!-- This is a comment. -->

General introduction about the topic and then an introduction of the
tutorial (the questions and the objectives). It is nice also to have a
Expand All @@ -157,6 +154,7 @@
[bibliography section](#bibliography) which will automatically be created at the end of the
tutorial.

<!-- This is a comment. -->

**Please follow our
[tutorial to learn how to fill the Markdown]({{ '{{' }} site.baseurl {{ '}}' }}/topics/contributing/tutorials/\
Expand Down
7 changes: 2 additions & 5 deletions tests/data/training_tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ contributors:
- the_best_contributor
---

# Introduction
{:.no_toc}

The introduction

> ### Agenda
> <agenda-title></agenda-title>
>
> In this tutorial, we will deal with:
>
Expand All @@ -32,4 +29,4 @@ The introduction

# First section

# Second section
# Second section
7 changes: 2 additions & 5 deletions tests/data/training_tutorial_wo_zenodo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ contributors:
- the_best_contributor
---

# Introduction
{:.no_toc}

The introduction

> ### Agenda
> <agenda-title></agenda-title>
>
> In this tutorial, we will deal with:
>
Expand All @@ -32,4 +29,4 @@ The introduction

# First section

# Second section
# Second section
7 changes: 2 additions & 5 deletions tests/data/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ contributors:
- the_best_contributor
---

# Introduction
{:.no_toc}

The introduction

> ### Agenda
> <agenda-title></agenda-title>
>
> In this tutorial, we will deal with:
>
Expand All @@ -32,4 +29,4 @@ The introduction

# First section

# Second section
# Second section
2 changes: 1 addition & 1 deletion tests/test_training_tutorial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ def test_tutorial_write_hands_on_tutorial() -> None:
with open(tuto.tuto_fp) as tuto_f:
tuto_c = tuto_f.read()
assert "layout: tutorial_hands_on" in tuto_c
assert "# Introduction" in tuto_c
assert "<agenda" in tuto_c
assert "URL1" in tuto_c
assert "# Conclusion" in tuto_c
shutil.rmtree("topics")
Expand Down