Project Structure

A generated and built Pharaoh project has following directory structure:

πŸ“ <project-name>
β”œβ”€β”€ πŸ“„ pharaoh.yaml
β”‚       Contains all settings and component definitions.
β”œβ”€β”€ πŸ“„ log.txt
β”‚       Build logs for all logging levels.
β”œβ”€β”€ πŸ“„ log_warnings.txt
β”‚       Build logs for logging levels WARNING and higher.
β”œβ”€β”€ πŸ“„ pharaoh_report_<timestamp>.zip
β”‚       A ZIP archive of the built report.
β”œβ”€β”€ πŸ“„ .gitignore
β”‚       A file for GIT to ignore all transient files.
β”œβ”€β”€ πŸ“ report-build
β”‚       Contains the build output, e.g. HTML pages or LaTeX input files.
β”‚       For HTML output the main page is called index.html.
└── πŸ“ report-project
    β”œβ”€β”€ πŸ“ .resource_cache
    β”‚       Contains temporary/cached resources
    β”œβ”€β”€ πŸ“ _static
    β”‚       Contains the CSS overrides and the HTML logo for the report.
    β”œβ”€β”€ πŸ“ _templates
    β”‚       Contains HTML templates that override the defaults of the selected Sphinx theme.
    β”‚       In the case layout.html and footer.html. Only change if you really need to.
    β”œβ”€β”€ πŸ“ .asset_build
    β”‚       All registered assets from asset generation will be stored here for each component separately.
    β”œβ”€β”€ πŸ“ components
    β”‚       This is where components get created when added via the project API.
    β”œβ”€β”€ πŸ“ user_templates
    β”‚       Stores user-defined templates for the build-time templating step.
    β”œβ”€β”€ πŸ“„ conf.py
    β”‚       The Sphinx configuration file (https://www.sphinx-doc.org/en/master/usage/configuration.html)
    β”‚       It loads a default configuration from the Pharaoh project into local variables.
    β”‚       Used to overwrite or add additional configuration.
    β”œβ”€β”€ πŸ“„ debug.py
    β”‚       For debugging the asset/report generation. Modify for your needs.
    β”‚       Per default it executes asset generation and report build.
    β”œβ”€β”€ πŸ“„ index.rst
    β”‚       The default template to control how the title page looks like.
    β”‚       It includes all components into the TOC (table of content) tree.
    β”œβ”€β”€ πŸ“„ index.rst.rendered
    β”‚       *.rendered files are generated during build-time templating step and allow to see the
    β”‚       actual rST content Sphinx is using for generating the report.
    β”‚       This helps for debugging your templates since you see the result after the templating step.
    └── πŸ“„ \*.cmd
            Scripts to execute asset generation, report build or upload to R&D Datalake with a single double-click.