Best Practices in RSE
In-code documentation
Writing good README files
Sphinx and Markdown
Popular tools and solutions
Motivation and wishlist
Summary
Why automated testing?
Testing locally
Test design
Conclusions and recommendations
Part 2: Automation on Software Forges and CI
Automation on Forges and CI
Testing on software forges
Testing on software forges: Full collaborative workflow
Deploying Sphinx documentation
Hosting websites/homepages on GitHub Pages
Other features
Reference
Shell crash course
Quick Reference
List of exercises
Instructor guide
Credit and license
About
All lessons
CodeRefinery
Reusing
Best Practices in RSE
Index
Edit on GitHub
Index
L
L
linting