Contributing to SymPy

This section discusses the necessary steps and guidelines required to contribute to the SymPy project. The TOC has links to the detailed development process.

Content

• Development Environment Setup
  • Git Setup
  • Get the SymPy Code
  • Virtual Environment Setup
  • Run the Tests
• Dependencies
  • Hard Dependencies
  • Optional Dependencies
  • Development Dependencies
• Build the Documentation
  • Required dependencies
  • Build the Docs
  • View the Docs
  • Auto-Rebuild with the Live Server
  • PDF Documentation
• Debugging
• SymPy Docstrings Style Guide
  • General Guidelines
  • Formatting
  • Sections
  • Sample Docstring
  • Docstrings for Classes that are Mathematical Functions
  • Best Practices for Writing Docstrings
  • Importing Docstrings into the Sphinx Documentation
  • Cross-Referencing
• General Guidelines
• Types of Documentation
• Narrative Documentation Guidelines
• Documentation using Markdown
• Best Practices for Writing Documentation
  • Formatting Preferences
  • Style Preferences
  • Tone Preferences
• Making a Contribution
• Deprecation Policy
  • What is a deprecation?
  • Try to avoid backwards incompatible changes in the first place
  • When does a change require deprecation?
  • The purpose of deprecation
  • How long should deprecations last?
  • How to deprecate code