Skip to content

Commit

Permalink
rename title to "How to document your research software"
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Aug 8, 2023
1 parent c48d5e3 commit e99556e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code documentation lesson
# How to document your research software

- [Credit and license](https://coderefinery.github.io/documentation/license/)
- [How to preview the lesson locally](https://coderefinery.github.io/sphinx-lesson/contributing-to-a-lesson/#build-and-test-locally)
4 changes: 2 additions & 2 deletions citation.cff
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ authors:
given-names: "Marijn"
- family-names: "Orozco"
given-names: "Luisa"
title: "CodeRefinery Documentation lesson"
title: "How to document your research software"
type: "data"
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."
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."
version: 1.0.0
date-released: 2023-08-08
url: "https://coderefinery.github.io/documentation/"
Expand Down
2 changes: 1 addition & 1 deletion content/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ of time.
### Detailed schedule

```markdown
* 10:45 - 12:30 Documentation
* 10:45 - 12:30 How to document your research software
- 10:45 - 10:55 Motivation and tools
- create a wishlist in HackMD
- 10:55 - 11:05 Break
Expand Down
4 changes: 2 additions & 2 deletions content/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Code documentation
==================
How to document your research software
======================================

In this lesson we will discuss different solutions for implementing and
deploying code documentation.
Expand Down

0 comments on commit e99556e

Please sign in to comment.