pydocmd.yml

site_name: "LTB support for Leo-III"

# This tells pydocmd which pages to generate from which Python modules,
# functions and classes. At the first level is the page name, below that
# is a tree of Python member names (modules, classes, etc.) that should be
# documented. Higher indentation leads to smaller header size.
generate:
- data.md:
  - leo3ltb.data.ltb++
  - leo3ltb.data.problem:
    - leo3ltb.data.problem.Problem+
    - leo3ltb.data.problem.ProblemVariant+
- executable.md:
  - leo3ltb.executable:
    - leo3ltb.executable.parse_args+
    - leo3ltb.executable.batch_from_args+
    - leo3ltb.executable.batches_from_args+
- context.md:
  - leo3ltb.context:
    - leo3ltb.context.processBatch+
    - leo3ltb.context.processBatches+
    - leo3ltb.context.LTBBatchContext+
- scheduler.md:
  - leo3ltb.scheduler:
    - leo3ltb.scheduler.scheduler
    - leo3ltb.scheduler.scheduler.ProveScheduler+
    - leo3ltb.scheduler.scheduler.Leo3SchedulerProcess+
    - leo3ltb.scheduler.scheduler.ProveSchedulerProcess+

# MkDocs pages configuration. The `<<` operator is sugar added by pydocmd
# that allows you to use an external Markdown file (eg. your project's README)
# in the documentation. The path must be relative to current working directory.
# This configuration is not mandatory if you have your own mkdocs.yml config file.
pages:
- Home: index.md
- Proving:
  - leo3ltb.executable: executable.md
  - leo3ltb.context: context.md
  - leo3ltb.data: data.md
  - leo3ltb.scheduler: scheduler.md

# These options all show off their default values. You don't have to add
# them to your configuration if you're fine with the default.
docs_dir: sources
gens_dir: docs/     # This will end up as the MkDocs 'docs_dir'
site_dir: .docs-html/site
theme:    readthedocs
loader:   pydocmd.loader.PythonLoader
preprocessor: pydocmd.preprocessor.Preprocessor

# Whether to output headers as markdown or HTML.  Used to workaround
# https://github.com/NiklasRosenstein/pydoc-markdown/issues/11.  The default is
# to generate HTML with unique and meaningful id tags, which can't be done with
# markdown.
#
# Note: if using the simple generator mode, this will default to 'markdown'
# instead of 'html'.
headers: markdown

# Additional search path for your Python module. If you use Pydocmd from a
# subdirectory of your project (eg. docs/), you may want to add the parent
# directory here.
additional_search_paths:
- ..