Developer documentation

Contents

• Development Quickstart
• 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
  • External plugins
  • Register your plugin
  • Plugin entry points
• Translation
  • Requirements
  • Init Transifex project
  • Update translations
• Makefile
  • Python environment
  • make run
  • make clean
  • make docs docs.autobuild docs.clean
  • make docs.gh-pages
  • make test
  • make test.sh
  • make test.pylint
  • search.checker.{engine name}
  • 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