documentation/python: bad documentation copypaste? probably.

documentation/python: minor cleanup.

m.dox: minor cleanup.

m.code, m.math: test & fix nested backticks in interpreted roles.

Broken when fixing backslash support.

m.dox: doc++

m.sphinx: implement intersphinx read support.

Intersphinx write support next.

documentation/python: implement documenting function params and return.

Did not expect I would need to patch Docutils for this because nobody had
this use case since its initial commit in 2002. How the heck is Sphinx
doing this, are they replacing Docutils internals too?!

documentation: add an actual diagnostic to this assert.

Seems to be hit quite often, so make it helpful.

css: make .m-diary left padding large enough to fit a short date as well.

And remove the extraneous margin -- which basically makes it look
roughly the same as before, but without uglily wrapped things.

Doc++

documentation/python: added TODOs for enum value docs.

documentation/python: support external docs for all stuff.

And also detailed docs for enums, functions, properties and data.

doc: remove outdated / redundant info.

documentation/python: um, why don't I use a function here?

Add file encoding to .editorconfig.

doc: Python doc generator *can* search now.

documentation/doxygen: fix last remaining use of deprecated name attrib.

documentation/python: hook up the search.

documentation: trim spaces from the right only if nothing is found.

With unconditional trimming it was not possible to narrow down results
for page titles containing spaces (or subpages, which are separated by
double right arrow surrounded by spaces).

documentation: reuse the saved searched string instead of creating it again.

This avoids duplicating the trimming/decoding logic.

documentation: provide autocompletion in UTF-8 as well.

The search() function returns the result list in UTF-8, but the
autocompletion was not. And of course renderResults() assumed it was in
UTF-8 and decoded it from UTF-8 *twice*. This wasn't discovered until
now because I had no pages with UTF-8 names apart from the test (which
doesn't test the UI stuff).

documentation/doxygen: insert also pages with all prefixes.

Not sure why there was an exception. This makes it practically
impossible to search for subpages.

css: highlight active documentation entries the same as sections.

For Python code, many names will have just the entry without any
detailed docs and it's hard to see where on the page it is if it's not
selected. The same works for Doxygen, of course.

documentation/doxygen: move entry ID to the <dt> element.

And it's no longer the deprecated name attribute, but rather an id.

documentation/python: move entry ID to the <dt> element.

Fancy new stuff incoming!

documentation: trim overly long search results even more.

The function name should be shown fully, ideally together with a
recognizable prefix.

documentation: properly show 100+ when having more results that can fit.

This got accidentally broken in 8bdb844ceb547d8ca3156ef815de9603e51a598a
when implementing the Tab autocompletion. Unfortunately I can't really
auto-test the UI code :/

documentation: re-render symbol count if search box gets shown again.

The (stale) count of found symbols was preserved there even though the
search box got emptied again. Also deduplicated the code a bit.

documentation: make it possible to have more than 128 results for a node.

Python's __init__ is the main offender, the (currently very barebone)
Magnum Python bindings have 340 results for __init__. This change is
based on the assumption that nodes with extreme amount of results on the
other hand don't have many children, so we can steal some bits from the
child count instead. Now it's either up to 127 results and up to 127
children or up to 2048 results and 16 children.

documentation: doc++

documentation: make the general search tests backend-independent.

It stays C++-specific, but since the implementation doesn't care about
the language, it's okay.

documentation/python: wtf, why None and why not [].

This was *sometimes* failing during the test, with Jinja complaining
that None is not iterable. But not all the time, for some reason.

documentation/python: extract the name shortener utility.

documentation/python: minor cleanup.

documentation/python: pass the whole entry to documentation extractors.

Compared to basically unpacking the entry and passing all of it as
separate arguments this makes it easier to get the page URL and in the
future also other stuff.

documentation/python: save URLs of crawled classes, modules and pages.

Makes link creation much simpler later.

documentation: search data format version 2.

Instead of having a hardcoded mapping from flags to type names and
associated classes on the JavaScript side, which was very C++-specific,
the new format now moves this mapping directly into the search data.

It's a new section at the end, for each type index containing CSS class
ID (which is still hardcoded, but that's not language specific anyway)
and an UTF-8 name that's displayed in the label. For C++ this makes the
search data file size 107 bytes larger, which isn't significant by any
means.

documentation: remove dead code.

documentation: ensure the extra arguments are always passed as keywords.

documentation: encode format version into search data filename.

The browser having a stale data (and a stale script) cached is okay-ish
as things still mostly work, but having a stale data with a script
expecting a new version or vice versa is *bad*, so prevent that by
having the script always download file of the exact version it expects.

This is a bit less useful with docs served from local filesystem (as
the filename is encoded in HTML pages rather than in the script), but
there I don't assume the browser is doing much caching so that should be
okay.

documentation: add sanity checks for always-defined template variables.

documentation: make the search test data diffable.

documentation: first step to make the result types backend-specific.

The type is now a part of the doxygen script and is added as plain bits
to ResultFlag. Next step is encoding the type mapping to the search data
and then reading that back in the JS frontend.

documentation/doxygen: update JS tests and ensure it doesn't happen again.

Ugh. The flags got reordered in 1a10e178fbf4d370ba1ae3026e5492c757cfef2e
(HALF A YEAR AGO!) but the JS test data were never adapted to that, so
the JS test was still working with the old stuff.

The Travis CI job was modified to execute the python script during
the JS test run and verify there's no git diff after that.

documentation: move search-related stuff into a dedicated module.

So it can be used by the Python doc generator as well. Wanted to put it
into __init__.py, but Guido disagreed with that, so I can't.

m.math, documentation: update math support for dvisvgm 2.6.3.

It reorders all XML attributes for no reason. Ugh I hate this.

m.math: ensure cache file is reset when cache is not used.

Otherwise tests run in batch can sporadically fail.

m.qr: patch the output to be consistent between Travis any my Python 3.7.

package/ci: build for Python 3.7 and pybind 2.3 as well, drop 3.4 build.

Drop Python 3.4 support.

It was EOL'd in March 2019 and I don't want to bother with it anymore.

documentation/python: handle also getset descriptors.

Ugh enough with those weird things already.

documentation/python: properly handle inspection of slot properties.

There's no fget/fset/fdel for those and we also can't __doc__ them.

documentation/python: reduce annotation test to just parsing, not links.

Type links are tested in test_inspect.TypeLinks.

documentation/python: reduce needed test boilerplate.

Will do the same for doxygen, plugin and theme tests too, but later.

documentation/python: warn when a type link should (but isn't) resolved.

Could help with figuring out what types were accidentally omitted from
the docs.

documentation/python: attrs does bad things and I'm not happy about that.

documentation/python: further improve type annotation support.

This is an awful mess, ffs. Like if nobody designed this with
introspection in mind.

documentation/python: minor clarification in a test.

documentation/python: properly handle invalid annotation types.

Such as using a tuple instead of Tuple or putting a function there
instead of a type.

documentation/python: properly handle nested pybind signature parse errors.

I still feel uneasy throwing exceptions. But eh.

documentation/python: properly parse pybind's Callable annotations.

documentation/python: clean up redundant imports.

documentation/python: test pybind readonly properties, for completeness.

documentation/python: support write-only properties.

Supported by Python through a slightly crazy syntax and in pybind11
since 2.3.

documentation/python: unify and improve formatting of values.

Such as function default values or data values. Mainly done in order to
turn enum values into links. Also ensuring the value is always HTML
escaped.

documentation/python: inspect pybind type __annotations__ carefully.

The typing.get_type_annotations() crashes with a KeyError there because
there's no pybind11_builtins module. I don't know and don't want to know
what's happening there.

documentation/python: allow relative links in top navbar.

For (local) Magnum Python docs I need to link to C++ docs, which are in
../../../bla/index.html.

documentation/python: doc++

documentation/python: better name for a function.

documentation/python: crawl also enum values.

No functional change, just a preparation for linking to enum values.

documentation/python: stay compatible with Python 3.6.

documentation/python: robust linking also for nested/generic types.

Wow of course this again took me ten times more than originally
anticipated, because there are NO FREAKING DOCS AT ALL for the typing
module.

The major advantage of the new (hard to implement) approach is that
string annotations are parsed and dereferenced correctly as well. That
also means the previous way I did them (fully qualified names) was
mostly wrong.

documentation/python: test link formatting also for type links.

documentation/python: implement linking for types.

documentation/python: properly handle recursively imported modules.

Basically converting the crawl to be breadth-first instead of
depth-first and maintaining a set of crawled modules to ensure they're
never visited again.

This could happen with classes as well, but it's rarer -- one would need
to add it to __all__ twice (or once and then it gets discovered
implicitly) etc. For now I'm simply asserting, will revisit in case it
proves to be an actual problem.

documentation/python: minor code reorganization.

documentation/python: inline functions that are used in a single place.

Those are the ugliest, ha. Keep them together.

documentation/python: format also anchors for class/module members.

First step towards symbol crosslinking.

documentation/python: make it possible to configure how URLs look.

Well, this is a bit overdone preparation for links to actual class /
module members, but can't hurt, no?? :D

documentation/python: crawl the names first to build a name map.

And then render eeach page non-recursively. That helps with
deduplicating the code (although the result is more code now), memory
usage (we're freeing everything before continuing to render another
page) and prepares the codebase for crosslinking and search.

pelican-theme: nope, this PR is still not merged yet.

documentation/python: adapt to a minor change in pybind 2.3 signatures.

documentation/doxygen: fixed link to defines section.

Vanilla HTML Doxygen output uses #define-members and that's what was
used to define the section ID, however the link to it was by mistake
just #defines.

package/ci: use matplotlib 3.0 on the CI.

m.plots: adapt for matplotlib 3.0.

3.0 uses a HTTPS URL in the SVG preamble, so the regex needed updating.
That's it. And I was putting this off for over a year, heh.

Well, actually now I have THREE DIFFERENT OUTPUTS to test for --
Python 3.5 and older has slightly different number rounding, while
matplotlib 3.1 adds a CSS property that 3.0 didn't have. Yay this is
annoying as hell.

package/ci: use latest Jinja on the CI.

Should work again.

Doc++

Trim extra trailing newlines before passing it to Jinja's indent().

In Jinja 2.9 indent() unconditionally stripped the trailing newline, in
2.10 it preserves it. That ... actually makes sense, so we have to
adapt.

m.htmlsanity: add a rtrim Jinja2 filter.

Argh, I wanted to update to Jina 2.10 without workarounds, but it's not
possible.

css: allow customizing text line height.

css: allow variables to be defined in terms of other variables.

Revert "documentation: fix for duplicate detailed description issue."

Wait no, this was a total brainfart. Things continue to work even
without those (and the new branches are OTOH never actually executed).

This partially reverts commit d1961231589a1cdf7a742d1f55a8daaf4533dfd6.

documentation: allow tests to run under MacOS and Windows.

documentation: these two also had duplicate detailed description issues.

documentation: fix for duplicate detailed description issue.

Also fixes issue with group (module) defined across two files.

documentation/doxygen: defines *can* appear twice, too.

In a group and in file docs. So accomodate for that.

documentation: test issues with duplicate detailed descriptions.

Also shows issues that come up when groups (modules) are spread over
multiple files.

Updated CREDITS.rst.

documentation/python: test for external docs that get unused.

Those should print a warning and not affect the output in any way.

documentation/doxygen: "improve" empty page filtering.

By throwing more mud at the wall. Ugh. Wow doxygen, why is everything
so damn hard.