Logo
Pharaoh v0.9.3
  • 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
        • Adding Components
        • Updating Components
        • Removing Components
        • Finding Components
      • Built-In Templates
    • Assets
      • What’s an Asset?
      • Executing Asset Generation
      • Debugging Asset Scripts
      • Implementing Asset Scripts
        • Metadata Stack
        • Manually Registering Assets
        • Catching Errors
        • Patched Frameworks
        • Force Static Exports
        • Matlab Integration
      • Asset Lookup
        • Asset Finder
        • Manual Include
        • Grouping Assets By Metadata
    • Pharaoh Directive
      • Directive Options
      • Asset Templates
    • Building
      • Configuration
      • Build API
      • Archiving
    • Templating
      • Generation-time Templating
        • Basics
        • Single-file Templates
      • Build-time Templating
        • Template Inheritance
        • Rendering Context
        • Extending Template Syntax
    • API Reference
      • Pharaoh API Module
        • get_project()
        • PharaohProject
          • PROJECT_SETTINGS_YAML
          • __init__()
          • add_component()
          • add_template_to_component()
          • archive_report()
          • asset_build_dir
          • asset_finder
          • build_report()
          • filter_components()
          • find_components()
          • generate_assets()
          • get_default_sphinx_configuration()
          • get_resource()
          • get_setting()
          • get_settings()
          • iter_components()
          • iter_resources()
          • load_settings()
          • open_report()
          • project_root
          • put_setting()
          • remove_component()
          • save_settings()
          • settings_file
          • sphinx_report_build
          • sphinx_report_project
          • sphinx_report_project_components
          • update_resource()
      • Asset Generation API Module
        • catch_exceptions()
        • find_components()
        • get_asset_finder()
        • get_current_component()
        • get_resource()
        • metadata_context()
        • register_asset()
        • register_templating_context()
        • AssetFinder
          • __init__()
          • discover_assets()
          • get_asset_by_id()
          • iter_assets()
          • search_assets()
          • sort_assets()
        • Asset
          • copy_to()
          • read_bytes()
          • read_json()
          • read_text()
          • read_yaml()
        • asset_groupby()
      • Resources
        • FileResource
          • first_match()
          • get_files()
          • get_match()
          • last_match()
          • locate()
        • CustomResource
        • Resource
        • LocalResource
          • locate()
        • TransformedResource
          • transform()
      • Matlab Integration API
        • Matlab
          • __enter__()
          • __exit__()
          • __init__()
          • connect()
          • eng
          • execute_function()
          • execute_script()
          • show_gui()
      • Templating Builtins
        • Jinja2 Builtins
        • Pharaoh Extension
          • Globals
            • assert_true()
            • fglob()
            • hrule()
            • raise_helper()
            • heading()
            • rand_id()
            • read_text()
          • Filters
            • hasattr_()
            • required()
            • rep()
            • or_default()
            • oc_resolve()
            • oc_get()
            • exists()
            • to_path()
            • md2html()
            • rsub()
        • Ansible Filters
      • Plugin API
    • CLI Reference
      • Preface
      • Commands
        • New
        • Add
        • Update-resource
        • Add-template
        • Remove
        • Env
        • Generate
        • Build
        • Show-report
        • Archive
        • Info
        • Print-plugins
  • Plugins
    • Plugin Architecture
      • Hookspec Markers
        • pharaoh_add_cli_commands()
        • pharaoh_asset_gen_prepare_resources()
        • pharaoh_asset_gen_started()
        • pharaoh_build_finished()
        • pharaoh_build_started()
        • pharaoh_collect_default_settings()
        • pharaoh_collect_l1_templates()
        • pharaoh_collect_l2_templates()
        • pharaoh_collect_resource_types()
        • pharaoh_configure_sphinx()
        • pharaoh_find_asset_render_template()
        • pharaoh_get_asset_render_template_mappings()
        • pharaoh_modify_gitignore()
        • pharaoh_project_created()
        • pharaoh_sphinx_app_inited()
  • Examples
    • Demo Reports
      • HTML
        • Measurement Report
      • Confluence
        • Trend Report
    • Asset Scripts
  • Contact
    • Help!
    • Bug reports
  • Release History
    • 0.9.3
    • 0.9.2
    • 0.9.1
    • 0.9.0
    • 0.8.3
    • 0.8.2
    • 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
        • Contents of a changelog entry
      • Creating a new release
        • Current maintainers
Pharaoh
  • Reference
  • View page source

Reference

  • Project Structure
  • Settings
    • Default Settings
    • Custom Settings
    • Accessing Settings
    • Custom Resolvers
  • Components
    • What’s a Component?
    • Resources
    • Templates
    • Managing Components
      • Adding Components
      • Updating Components
      • Removing Components
      • Finding Components
    • Built-In Templates
  • Assets
    • What’s an Asset?
    • Executing Asset Generation
    • Debugging Asset Scripts
    • Implementing Asset Scripts
      • Metadata Stack
      • Manually Registering Assets
      • Catching Errors
      • Patched Frameworks
      • Force Static Exports
      • Matlab Integration
    • Asset Lookup
      • Asset Finder
      • Manual Include
      • Grouping Assets By Metadata
  • Pharaoh Directive
    • Directive Options
    • Asset Templates
  • Building
    • Configuration
    • Build API
    • Archiving
  • Templating
    • Generation-time Templating
      • Basics
      • Single-file Templates
    • Build-time Templating
      • Template Inheritance
      • Rendering Context
      • Extending Template Syntax
  • API Reference
    • Pharaoh API Module
      • get_project()
      • PharaohProject
    • Asset Generation API Module
      • catch_exceptions()
      • find_components()
      • get_asset_finder()
      • get_current_component()
      • get_resource()
      • metadata_context()
      • register_asset()
      • register_templating_context()
      • AssetFinder
      • Asset
      • asset_groupby()
    • Resources
      • FileResource
      • CustomResource
      • Resource
      • LocalResource
      • TransformedResource
    • Matlab Integration API
      • Matlab
    • Templating Builtins
      • Jinja2 Builtins
      • Pharaoh Extension
      • Ansible Filters
    • Plugin API
  • CLI Reference
    • Preface
    • Commands
      • New
      • Add
      • Update-resource
      • Add-template
      • Remove
      • Env
      • Generate
      • Build
      • Show-report
      • Archive
      • Info
      • Print-plugins
Previous Next

© Copyright . Last updated on Jun 23, 2025.

Built with Sphinx using a theme provided by Read the Docs.