Skip to content

Github Service injects additional need types + layout -> configuration changed #1714

@oliverbl

Description

@oliverbl

sphinx-build detects configuration changes, allthough conf.py is unchanged.

loading pickled environment... The configuration has changed (3 options: 'needs_layouts', 'needs_types', 'pygments_dark_style')

Codex found that the fields need_layouts and needs_types are changed by GithubService
Following workarounds:

Fix for layout:

needs_layouts = {
      "example_layout": { ...},
       # workaround
      "github": deepcopy(GITHUB_LAYOUT),
}

Fix for directives:

needs_types.extend(
    [
        {
            "directive": "issue",
            "title": "Issue",
            "prefix": "IS_",
            "color": "#cccccc",
            "style": "card",
        },
        {
            "directive": "pr",
            "title": "PullRequest",
            "prefix": "PR_",
            "color": "#aaaaaa",
            "style": "card",
        },
        {
            "directive": "commit",
            "title": "Commit",
            "prefix": "C_",
            "color": "#888888",
            "style": "card",
        },
    ]
)

Then:

loading pickled environment... The configuration has changed (1 option: 'pygments_dark_style')

It doesnt seem to affect the actual build process.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions