-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
preparing the schedule for doc and testing
- Loading branch information
Showing
3 changed files
with
22 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
(documentation)= | ||
|
||
# Code documentation | ||
|
||
- 15 min: What makes good documentation? Also https://diataxis.fr/ | ||
- 15 min: Writing good README files | ||
- 30 min: Exercise: Set up a Sphinx documentation and add API documentation | ||
- 15 min: Building documentation with GitHub Actions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
(testing)= | ||
|
||
# Automated testing | ||
|
||
- 15 min: Motivation | ||
- 15 min: End-to-end tests | ||
- 15 min: Pytest | ||
- 15 min: Moving to GitHub Actions | ||
- 20 min: Exercise | ||
- 10 min: Where to go from here |