Best Practices in RSE
Part 1 - Documentation
In-code documentation
Writing good README files
Sphinx and Markdown
Popular tools and solutions
Motivation and wishlist
Summary
Part 1 - Testing
Motivation
Testing locally
Test design
Conclusions and recommendations
Part 2: Automation on Software Forges and CI
Automated testing
(Optional) Full-cycle collaborative workflow
Deploying Sphinx documentation to GitHub Pages
Hosting websites/homepages on GitHub Pages
Reference
Shell crash course
List of exercises
Instructor guide
Credit and license
About
All lessons
CodeRefinery
Reusing
Best Practices in RSE
Index
Edit on GitHub
Index