build.yml

#
# Configuration file for build.py,
# a notebook and documentation builder
#

# Paths used for all sections
paths:
  # where the Jupyter notebook source files are
  source: src
  # where the documentation (generated, hand-written) lives
  output: docs
  # the HTML output directory
  html: _build/html
# Settings for running and converting Jupyter Notebooks
notebook:
    # number of parallel 'workers' to run notebooks
    num_workers: 7
    # continue on errors (otherwise stop)
    continue_on_error: true
    # timeout
    timeout: 1200
    # if this is true, strip 'remove_cell' cells from the notebook as they
    # are converted
    strip: false
    # where to put error files. special values: '__stdout__',  '__stderr__'
    error_file: notebook-errors.txt
    # template file for the "_doc" wrapper RST file
    template: docs/jupyter_notebook_sphinx.tpl
    # List of directories to process. For each, source directory relative to
    # paths.source and output directory relative to paths.output. The "match"
    # string is a regular expression that acts as a filter: only files that
    # have that expression (here a simple string) in them will be processed.
    directories:
      - source: Examples/Advanced/CustomUnitModels
      - source: Examples/Advanced/CustomProperties
      - source: Examples/Advanced/DataRecon
      - source: Examples/Flowsheets
      - source: Examples/MatOpt
      - source: Examples/SurrMod/ALAMO
      - source: Examples/SurrMod/Helmet
      - source: Examples/SurrMod/PySMO
#      - source: Examples/SurrMod/RIPE
#        match: "RIPE_.*"
      - source: Examples/Tools
      - source: Examples/UnitModels/Operations
      - source: Examples/UnitModels/Reactors
      - source: Examples/Pecos
      - source: Tutorials/Advanced/ParamEst
      - source: Tutorials/Basics
# Settings for building the notebook index page.
# These can be overridden with options to the script.
notebook_index:
  input_file: notebook_index.yml
  output_file: src/notebook_index.ipynb
# Settings for running Sphinx build
sphinx:
    # Arguments that are given to 'sphinx-build' after arguments fixed in the code
    args: "-b html -T {output} {output}/{html}"
    # Error file for the sphinx errors (no special values)
    error_file: sphinx-errors.txt
    # Directory to create and use for linkchecker output
    linkcheck_dir: lc