ssg.build_guides module
- ssg.build_guides.build_index(benchmarks, input_basename, index_links, index_options, index_initial_src)[source]
- ssg.build_guides.builder(queue)[source]
Fetch from a queue of tasks, process tasks until the queue is empty. Each task is processed with generate_for_input_content, and the guide is written as output.
Raises: when an error occurred when processing a task.
- ssg.build_guides.fill_queue(benchmarks, benchmark_profile_pairs, input_path, path_base, output_dir)[source]
For each benchmark and profile in the benchmark, create a queue of tasks for later processing. A task is a named tuple (benchmark_id, profile_id, input_path, guide_path).
Returns: queue of tasks.
- ssg.build_guides.generate_for_input_content(input_content, benchmark_id, profile_id)[source]
Returns HTML guide for given input_content and profile_id combination. This function assumes only one Benchmark exists in given input_content!