Template contains mkdoclingo.css.

Issue

The template currently contains the file:

https://github.com/potassco/python-project-template/blob/master/docs/_custom/css/mkdoclingo.css

This means that every project that starts with the template overrides the css provided by mkdoclingo.

One such example is:

code.doc-clingo-symbol-predicate::after {
    content: "predicate";
    color: #ca91bf
}

which creates a label predicate. This label is used to show that something is a predicate and currently occurs in front of every link to a predicate in the table of contents (TOC).

Having the entire word predicate in front of every link is very verbose and takes up much of the space reserved for the TOC, resulting in unnecessary line breaks.

Additionally, this forces a very specific color.

For this reason the same css in mkdoclingo looks like this

code.doc-clingo-symbol-predicate::after {
    content: "P";
    color: var(--doc-symbol-predicate-fg-color);
}

Here, the content is only P and the color is applied dynamically from a variable.

Solution

I think the file should be removed entirely. In most cases, mkdoclingo should be responsible for the styling of the sections it provides. Only if custom styling is absolutely necessary/wanted should parts of mkdoclingo be overridden.

Start by inspecting docs/_custom/css/mkdoclingo.css and compare it with the styling provided by mkdoclingo. Remove the template CSS file, then verify that projects generated from the template no longer override mkdoclingo's predicate labels or colors.