Development Guidelines

Release:

0.6.1.dev1

Date:

February 20, 2024

• How to write documentation
• Getting build dependencies
  • Building the documentation
  • Viewing the documentation
  • Syntax
  • Style
  • Documentation Problems
• Sphinx Cheat Sheet
  • Making a list
  • Making a table
  • Making links
  • ipython sessions
  • Formatting text
  • Using math
  • Inserting matplotlib plots
  • Emacs helpers
  • Inheritance diagrams
  • This file
• Working with nipy source code
  • Introduction
  • Install git
  • Following the latest source
  • Making a patch
  • Git for development
  • git resources
• Commit message codes
• Pull request codes
• Testing
  • Automated testing
  • Writing tests
  • Running tests
  • Coverage Testing
• Debugging
  • Run in ipython
  • Embed ipython in crashing code
• Debugging the build
  • Debug for build failure
• Optimization
• Open Source Development
• A guide to making a nipy release
  • Release checklist
  • Doing the release
• The ChangeLog