Skip to content

Commit e99556e

Browse files
committed
rename title to "How to document your research software"
1 parent c48d5e3 commit e99556e

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Code documentation lesson
1+
# How to document your research software
22

33
- [Credit and license](https://coderefinery.github.io/documentation/license/)
44
- [How to preview the lesson locally](https://coderefinery.github.io/sphinx-lesson/contributing-to-a-lesson/#build-and-test-locally)

citation.cff

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ authors:
2626
given-names: "Marijn"
2727
- family-names: "Orozco"
2828
given-names: "Luisa"
29-
title: "CodeRefinery Documentation lesson"
29+
title: "How to document your research software"
3030
type: "data"
31-
abstract: "The documentation lesson gives an overview of the different ways how a code project can be documented: from small projects to larger projects. Markdown and Sphinx are central tools in this lesson."
31+
abstract: "The lesson 'How to document your research software' gives an overview of the different ways how a code project can be documented: from small projects to larger projects. Markdown and Sphinx are central tools in this lesson."
3232
version: 1.0.0
3333
date-released: 2023-08-08
3434
url: "https://coderefinery.github.io/documentation/"

content/guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ of time.
4747
### Detailed schedule
4848

4949
```markdown
50-
* 10:45 - 12:30 Documentation
50+
* 10:45 - 12:30 How to document your research software
5151
- 10:45 - 10:55 Motivation and tools
5252
- create a wishlist in HackMD
5353
- 10:55 - 11:05 Break

content/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Code documentation
2-
==================
1+
How to document your research software
2+
======================================
33

44
In this lesson we will discuss different solutions for implementing and
55
deploying code documentation.

0 commit comments

Comments
 (0)