Developer documentation

Contents

• Development Quickstart
  • How to setup your development environment
  • How to run tests
  • How to compile styles and javascript
  • How to build the source of the themes
  • Tips for debugging/development
• How to contribute
  • Prime directives: Privacy, Hackability
  • Code
  • Translation
  • Documentation
• Engine overview
  • general engine configuration
  • making a request
  • returned results
• Search API
  • Parameters
• Plugins
  • Example plugin
  • Plugin entry points
• Translation
  • Requirements
  • Init Transifex project
  • Update translations
• Makefile Targets
  • Makefile setup
  • Python environment
  • make run
  • make clean
  • make docs docs-live docs-clean
  • make gh-pages
  • make test
  • make pylint
  • make pybuild
• reST primer
  • Soft skills
  • Basic inline markup
  • Basic article structure
  • Anchors & Links
  • Literal blocks
  • Unicode substitution
  • Roles
  • Figures & Images
  • List markups
  • Admonitions
  • Tables
  • Templating
  • Tabbed views
  • Math equations