mrdocs::Session::create

Make the session of a run.

Synopsis

Declared in <mrdocs/Session.hpp>

static
Expected<Session>
create(
    Config config,
    std::shared_ptr<ExtensionRegistry::LibraryRegistry> libraries = nullptr);

Description

The session starts with the generators that ship with MrDocs. The reporter takes its level and warn‐as‐error from the configuration. The extensions of the configuration load first, so that a generator one of them installs takes precedence over an addon directory of the same id. Then the generators the addons define as data are discovered.

Return Value

The session, or the error if an extension failed to load or a generator could not be added.

Parameters

Name

Description

config

The configuration of the run. The session owns it.

libraries

The record of the native libraries loaded in this process, to share with other sessions. If null, the session makes one of its own.

Created with MrDocs