The distutils module has been deprecated, and will be
removed in a future version of Python.

config: Add "related" configuration key

See merge request GNOME/gi-docgen!145

List the new constraint on the dependencies key, and the newly added
related key.

Dependencies must be included in the introspection data.

Related libraries are part of the project configuration.

Related libraries should not be included in the "dependencies"
configuration.

template: Note functions that are not introspectable

See merge request GNOME/gi-docgen!144

Mention that a symbol can shadow another symbol, and that a symbol can be
shadowed by another symbol.

This information is mostly relevant to users of language bindings.

Methods and functions can shadow other symbols within the same type
and namespace; and, in turn, can be shadowed by other symbols.

We can use this information inside the templates when generating the
documentation.

style.css: Fix prefered typo

See merge request GNOME/gi-docgen!140

examples: Update urlmap

See merge request GNOME/gi-docgen!141

template: Nest toc-lists

See merge request GNOME/gi-docgen!142

generate: gpointer is a pointer

Closes #127

See merge request GNOME/gi-docgen!143

People using language bindings might end up in the C API reference, so it
would be nice to tell them that non-introspectable symbols might not be
available through bindings.

We need to special case gpointer and gconstpointer when deciding if a
C type is a pointer type.

Fixes: #127

Descriptions can have nested table of contents, so we need to visually
nest them in the navigation side bar.

Taken from gtk's urlmap.

gir: Improve the deprecation check

See merge request GNOME/gi-docgen!139

Instead of checking if deprecated_since is None, check for the
deprecated property.

Add a proxy for the deprecation bit, and return placeholder values in
case version or message are missing.

Deprecation annotations should have a version and a message, but neither
is mandatory.

If find a deprecation node, we explicitly mark the element as
deprecated.

Include the description's TOC in type templates

See merge request GNOME/gi-docgen!138

Like we do for extra content files, we should generate a TOC of the
sub-headings inside the description of types: classes, interfaces, and
structured data. This way it's easier to navigate to sub-sections, and
to get their location for links.

This way we can generate an index of the sub-headings inside the
description of a type.

Revert "Add tooltips to class hierarchy edges"

See merge request GNOME/gi-docgen!137

This reverts commit 15023b41.

The commit broke the graph generation, and will need to be re-done.

generate: Improve the TOC for content files

See merge request GNOME/gi-docgen!136

We can omit level 1 headings if there's only one of them, as it usually
means the title of the document; we should always show level 2 headings,
as they are more common in all cases.

Add tooltips to class hierarchy edges

See merge request GNOME/gi-docgen!134

Currently, when hovering over an edge between a class and its ancestor,
it gives a tooltip similar to `this--ancestor_0`.

This is not really informative and is probably even worse for people
with screen readers, as they can't see the diagram and can only get
confused by it.

Replace it with `$TYPE extends $TYPE` or `$TYPE implements $TYPE`.

enum template: Generate links for enum values and add some missing titles to the navbar

See merge request GNOME/gi-docgen!135

The current enum template only mentions the "Description" title (and
"Functions" if applicable). However, depending on how long the
description might be, it's a good idea to also add a link for quick
access to the members. There's also an error domain below that, so let's
link that as well.

This commit adds an anchor to the enum member, and uses the name of the
member (as specified in the GIR) to create a link.

Related to https://gitlab.gnome.org/GNOME/gi-docgen/-/issues/121

content files: generate a navbar with the headers

Closes #124

See merge request GNOME/gi-docgen!133

We're already using the ["toc"] extension of the Markdown module, which
allows us to get the header hierarchy after parsing as a list headers,
each represented as a recursive `dict`.

["toc"]: https://python-markdown.github.io/extensions/toc/

gir: Do not require a deprecation message

See merge request GNOME/gi-docgen!132

Symbols can be deprecated with just a version identifier, even though it
is preferable to have a message.

css: style keyboard shortcuts

Closes #122

See merge request GNOME/gi-docgen!131

- stay close to what libadwaita does

Fixes https://gitlab.gnome.org/GNOME/gi-docgen/-/issues/122

Fix typo in link

See merge request GNOME/gi-docgen!130