documentation/python: extend URL_FORMATTER also to static data.

m.sphinx: add an option to repack a decompressed inventory file.

m.sphinx: dirty hack to make this file directly runnable.

Because having to do

    python -m m.sphinx somefile.inv

is too unintuitive to remember.

m.sphinx: ensure fully qualified name links always have a precedence.

The previously added test now passes.

documentation/python: test that fully qualified links get a precedence.

They don't, unfortunately.

documentation/python: format overloaded func ID only if it's overloaded.

So "pybound" functions without overloads still can have nice IDs and
URLs. This should have been done together with
1cd0bb44b77b4225fc5156e1ea7c1a790fe9f7a8 and
6db6b4c4f8296b0fa1b08ce6edeb942db321f6b4 already, but somehow I didn't
make the connection.

documentation/python: avoid aliasing variables in signature parsing code.

And avoid unpacking the whole tuple when we need just one item. It was
very hard to reason about otherwise.

m.sphinx: allow to link to special pages.

documentation/python: add some TODOs.

plugins: leave this there commented-out so I don't need to search again.

m.sphinx: implement a page-wide :ref-prefix: option.

NOW I can start writing real docs without everything being a giant PITA.

documentation/python: fire scope hooks for page rendering as well.

Right now this will be used to implement a page-specific :ref-prefix:
option, but in the future it can be used also for relative linking to
pages and such.

doc: uh oh.

Various bits to improve code coverage.

documentation/python: pull additional stuff from __annotations__.

documentation/python: include documented underscored names.

documentation/python: don't die on reST errors in pages.

documentation/python: this copypaste is like a cancer.

Spreads everywhere.

documentation/python: avoid blowing up on __name__ not being an attrib.

Don't want to test for this, seems too obscure.

documentation/python: handle ... in type annotations.

Until now I didn't know code like `if annotation is ...` is possible.
What will come next, using // as an operator?!

documentation/python: gracefully handle nested annotation parsing failures.

documentation/python: don't be so enthusiastic with pybind sig matching.

documentation/python: test for false positives for pybind signatures.

This blows up. Heh.

documentation/python: try not to use `type` for a variable name.

I wanted to check a type of a variable there.

documentation/doxygen: don't use entity if it fails to be found.

m.code: doc++

Be consistent with the actual output.

m.code: ability to apply filters before/after the code is highlighted.

plugins: don't implicitly depend on Pelican.

Only when those actually get used from Pelican.

documentation/python: use an ellipsis for overly large values.

doc: the Python doc generator is not experimental anymore.

m.sphinx: ignore duplicate entries in intersphinx inventories.

The "index" is the main offender.

documentation/python: ensure relative includes work in parsed docs.

This is quite bad, but ... at least something.

documentation/python: add a NAME_MAPPING config option.

documentation/python: minor naming cleanup.

documentation/python, m.sphinx: support for external enum value docs.

m.sphinx: more convenient module/class data and properties documentation.

Sometimes all you need is just a summary. Discovered during a port of a
larger project, writing all those fully-qualified .. py:property:: for all
members got boring *really* fast.

m.sphinx: extended the section about by-design restrictions.

documentation/python: less responsibility on docstring-processing plugins.

Until now, the plugin was expected to fill both summary and content for
the symbol it's ccalled on. THat made plugin implementation harder than it
should be, causing a lot of code duplication and explosion of testing
effort.

Now the script simply sills in summary / content if it isn't there after
all processing and that's it. No asserts anymore.

documentation/python: consistently use a single way to render Jinja pages.

Otherwise I forget to specify important variables or do other critical
mistakes.

documentation/python: the feeling when you invert an important condition.

This was supposed to check that I was always specifying the version. Well,
it failed to check, and I failed to specify the version properly in all
cases.

documentation/python: implement a bunch of tricks for attrs.

Workarounds! Hacks! Smelly code!

documentation/python: properly shrink first column also with skipped self.

This will break if the docs skip undocumented parameters, but since that's
technically an error, I don't care.

documentation/python: don't forget to handle scope for slots as well.

m.sphinx: added a :p: role for parameter referencing.

So tiny yet so useful. Doxygen, take a note.

documentation/python: implement scope enter/exit hooks.

With this we can have relative links for *everything*.

documentation/python: minor cleanup, naming consistency.

documentation/python: dying on each error isn't nice.

documentation/python: AAAAHHHH.

The test failure from the previous commit is no more.

documentation/python: test external summary for a submodule.

Fails. It's amazing how far can some bugs go unnoticed.

documentation/python, m.sphinx: hook for parsing docstrings.

Centuries of work and research later, this gem is done. Yay!

m.sphinx: don't overwrite the docs gathered so far.

This won't work well when more plugins are involved or the directives are
used to parse docstrings. Also updated the plugin docs to not suggest this
practice.

doc: improve the python docstring info.

doc: move python documentation plugin internal docs later in the page.

These are not so useful for users, and the stuff that followed them was
too buried.

documentation/python: minor cleanup.

documentation/python: fix a copypasta in a test.

documentation/python: unconditionally go through reST for everything.

Well, of course not forcing reST formatting on plain docstrings -- just
having a single code path because that makes integrating 3rd party
processing easier. Results in absolutely no changes to test files, which
is absolutely amazing.

documentation/python: support documenting particular function overloads.

documentation/python: include params in search only for overloads.

And not unconditionally for all pybind functions. Makes the search data
lighter and is more consistent with pure Python code (and with the future
support for the @overload decorator).

documentation/python: detect overloaded functions already at crawl time.

But don't change the behavior in any way -- just that the consumers should
be aware of the distinction.

documentation/python: poison entry types that shouldn't go into search.

Spent a while using OVERLOADED_FUNCTION in a few places just to discover
it wasn't meant to be used there.

documentation/python: provide both type and type with links everywhere.

Makes it possible for templates to use those in different cases (such as
link alt text) and also unblocks the possibility to have separate docs for
function overloads (in the next commits).

documentation/python: special handling for self only if it's first.

I doubt anyone sane will name any other function parameters like that, but
let's be sure.

documentation/python: don't annotate free pybind function as staticmethods.

Wasn't visible in the output until now because we didn't have detailed
docs for those. But now it will be.

documentation/python: parse more than just first docstring paragraph.

Next step is to allow those to get processed using plugins.

documentation/python: minor cleanup.

documentation/python: verify that HTML escaping is done for pybind as well.

It is, even though I felt like it wasn't. Good to have to avoid
double-escaping accidents in the future.

documentation/python: whoops, enum detailed docs weren't rendered.

doc: fix for order-dependent processing, again.

theme: no, this PR is still not merged yet.

m.sphinx: ugh, I still need to support Python 3.5.

m.sphinx: ability to create intersphinx inventories as well.

m.sphinx: utility to pretty-print the inventory files.

The builtin sphinx tool is beyond useless. FFS.

m.dot: doc++

documentation/python: implement context-relative linking.

I didn't change much, but the amount of research needed to verify that I'm
indeed doing it (mostly) correct was extreme. There's a pathological case
inside a named subclass where I'm doing it differently than Python itself,
but I don't expect this to be hit very often, so postponing until later.

The tests also assert inside the function definitions (and those functions
get called) to verify we're indeed doing (mostly) correct stuff.

documentation/python: correctly link all type annotations as well.

documentation/python: prefix pybind's annotations with the typing module.

So it's consistent with pure Python annotations.

documentation/python: integrate tighter with m.sphinx.

The :ref: from m.sphinx can now link to internal types, while external
types provided by m.sphinx are now also linked to from all signatures.

Yay, I'm so happy about the design of this.

documentation/python: add implicit kwargs to all plugin hooks.

So they are future-proofed when new arguments are added. Need also *args
because pelican passes things unnamed.

documentation/python: added a post-crawl hook and exposed name map.

So m.sphinx can use it to add the internal names to its own search index
and also make an inventory for it.

documentation/python: yup, yet another variant of builtin math docstrings.

documentation/python: save URL to all entries to make linking easier.

documentation/python: revisit None in function return type annotations.

Until now it was ignored in pybind return annotations as it seemed to be
superfluous. OTOH, while the pybind function is fully annotated, it's
often not clear which function comes from pybind and which from pure
python code, meaning it's not clear if the return type is None or the
return type annotation is just missing.

Additionally, the pure python annotations were showing None as NoneType,
which is too verbose. According to PEP484 type(None) and None are
equivalent, so patching the output to show None instead of NoneType,
making it also consistent with pybind.

documentation/python: thanks to fixed reST higlighting I see this is dead.

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.