Pharaoh

Pharaoh is a Sphinx-based Python framework for generating reports in various format (HTML, Confluence, PDF) by combining the power of configurable Jinja templates and Python scripts for asset (tables, plots, pictures, etc…) generation.

Table of Contents

• Introduction
  • Working Principle
• Installation
  • Requirements
  • Installation via Pip
    • Create a virtual environment
    • Install
    • Extras
• User Guide
  • Preface
  • Project Generation
  • Update Settings
  • Manage Components
  • Manage Asset Scripts
  • Modify Templates
• Template Designer Guide
• Reference
  • Project Structure
  • Settings
    • Default Settings
    • Custom Settings
    • Accessing Settings
    • Custom Resolvers
  • Components
    • What’s a Component?
    • Resources
    • Templates
    • Managing Components
    • Built-In Templates
  • Assets
    • What’s an Asset?
    • Executing Asset Generation
    • Debugging Asset Scripts
    • Implementing Asset Scripts
    • Asset Lookup
  • Pharaoh Directive
    • Directive Options
    • Asset Templates
  • Building
    • Configuration
    • Build API
    • Archiving
  • Templating
    • Generation-time Templating
    • Build-time Templating
  • API Reference
    • Pharaoh API Module
    • Asset Generation API Module
    • Resources
    • Matlab Integration API
    • Templating Builtins
    • Plugin API
  • CLI Reference
    • Preface
    • Commands
• Plugins
  • Plugin Architecture
    • Hookspec Markers
• Examples
  • Demo Reports
    • HTML
    • Confluence
  • Asset Scripts
• Contact
  • Help!
  • Bug reports
• Release History
  • 0.8.1
  • 0.8.0
  • 0.7.4
  • 0.7.3
  • 0.7.2
  • 0.7.1
  • 0.7.0
  • 0.6.2
  • 0.6.1
  • 0.6.0
• Development
  • Getting started
    • Setup
    • Running from source tree
    • Running tests
    • Running linters and code formatters
    • Code style guide
    • Building documentation
  • Contributing
    • Submitting pull requests
    • Automated testing
    • Changelog entries
    • Creating a new release

Indices and tables

• Index

• Module Index

• Search Page