Developer Documentation

If you’re interested in contributing to arte, start here.

Development Guide

Learn about the development workflow, git practices, testing, and publishing.

• Development
  • Python version
  • (human) Language
  • Coding style
  • Developing guide

Code Convention

Coding style guidelines and conventions for arte development.

• code_convention
  • InafIsAnAcronym
  • NiceWriter

Documentation Guide

Best practices for writing documentation, docstrings, and contributing to the docs.

• Documentation Best Practices
  • General Principles
  • Docstring Style
  • LaTeX in Docstrings
  • Type Hints
  • Class Documentation
  • Module Documentation
  • Adding New Modules to Documentation
  • Testing Documentation
  • Jupyter Notebooks as Tutorials