documentation/python: gracefully handle also crazy return types.

documentation/python: parsing types of pybind11 properties.

documentation/python: parse pybind11 function signatures.

documentation/python: support pybind11-style submodules.

The usual detection fails there. Oh well.

documentation/python: support pybind11 enums.

documentation/python: make pybind11 compatibility opt-in.

This is becoming rather shitty.

documentation/python: module and class index.

documentation/python: adapt to slightly different internals in 3.6.

documentation/python: support enums.

documentation: initial version of the Python doc generator.

Inspecting modules, functions, classes, methods and properties, taking
the first line of the docstring for a brief docs. Nothing more at the
moment, no index or search is hooked up yet.

documentation/doxygen: reflow a comment.

Doc++

documentation: ignore more npm cruft.

documentation: ignore test files for code coverage.

Stupid fucking istanbul, now it's deprecated and renamed to nyc and
there's some magic that puts istanbul into PATH but only in the root
directory and I hate that.

m.alias: remove useless dependency on m.htmlsanity.

m.htmlsanity: make the plugin usable outside of Pelican.

documentation/doxygen: use proper CSS color in the test.

Doc++

Various updates to the contribution guide.

I spotted a bunch of Engrish and in the end went over everything.

doxygen: whoops, forgot to update the JS.

doc: whoops, forgot to commit this.

doc: fix another order-dependent rst processing error.

doc: moved sample Doxygen tagfile.

css: renamed m-doxygen.css to m-documentation.css.

And all .m-dox* classes to .m-doc*. It's not Doxygen-specific anymore.
Note this is a breaking change if you are using the Doxygen theme. In
particular:

 * all stylesheet references in HTML_EXTRA_STYLESHEETS have to be
   updated to reference m-dark+documentation.compiled.css instead of
   m-dark+doxygen.compiled.css
 * all processing scripts and theme derivations that were depending on
   the m-doxygen.css file need to reference m-documentation.css
 * all theme modifications need to use the m-doc prefix instead of
   m-dox for CSS classes

doc: adapted site to project organization changes.

Moved doxygen/dox2html5.py to documentation/doxygen.py.

And move the theme and test directory as well. Making room for Python
and other language support. Note this is a breaking change --- from now
on, you need to call the script as

    documentation/doxygen.py

instead of

    doxygen/dox2html5.py

Besides that, the location of default templates changed from
doxygen/templates/ to documentation/templates/doxygen/ --- if you have
your own modifications to these, you may need to move your files.

Moved plugins from pelican-plugins/ to plugins/.

Not just for Pelican for a long time already. Note this is a breaking
change --- if you're using the m.css Pelican theme, you need to update
your PLUGIN_PATHS to reference the new directory, for example:

    PLUGIN_PATHS = ['m.css/plugins/']

instead of

    PLUGIN_PATHS = ['m.css/pelican-plugins/']

If you're using the Doxygen theme or just the CSS files, nothing changes
for you.

doxygen: fix namespaced classes with base/derived in the root NS.

Boom. Interesting, no project until now hit this particular case.

doxygen: avoid showing undocumented enum values twice.

doxygen: option to show undocumented symbols.

Done simply as a preprocessing step by populating the <briefdescription>
for each symbol that has neither <briefdescription> nor
<detaileddescription> with an empty <span>. That's all.

doxygen: \code can be also inside \m_span.

doxygen: *actually* not strip leading whitespace in a block.

The condition was inverted and the test was not testing anything. Ugh.

oelican-theme: avoid using deprecated PAGINATED_DIRECT_TEMPLATES.

m.images: make it possible to provide custom titles for image grid.

m.htmlsanity: graceful docutils error handling in the render_rst filter.

Like I did for Pelican 4.

m.htmlsanity: don't add an useless class to section titles.

m.htmlsanity: style footnotes with our CSS classes.

Doc++

css: semi-transparent code background also in colored table rows/cells.

css: styling for footnotes and footnote references.

Updated .gitignore.

site: fixes for order-dependent processing, again.

site: show coverage info in Build Status.

doxygen: fall back to the default template location from --template.

So people don't need to provide the whole copy, just the modified files.

doxygen: support the \internal command.

doxygen: show the final label of a class also in the class tree.

doxygen: parse function attributes also without leading space.

doxygen: it gets extra shitty when encountering decltype(auto).

Seriously, is the parser a box full of angry monkeys?! How is this
possible.

doxygen: more workarounds for insane multiline brief bugs.

doxygen: treat QT_AUTOBRIEF the same way as JAVA_AUTOBRIEF.

Similar bug ratio.

doxygen: mention that SHOW_NAMESPACES = NO is not supported.

doxygen: work around a bug related to HTML <a name=""> anchors.

Consistency FTW. Yay.

doxygen: harden the "anchor in both group and namespace" test.

doxygen: support image links.

Yay? Nah. It's still crappy, you still can't have \image inside \ref.

m.code: don't strip leading whitespace in blocks.

m.images: support width/height/scale options.

m.dot: support plaintext node shapes as well.

m.dox: the <file> doesn't need to have <path>.

Happens with the updated STL tag files from cppreference.com.

css: provide CSS classes for <em>, <strong>, <sup>, <sub> and <s>.

For cases where one can't use the tags (some cases with reST, Doxygen
etc.). The .m-em and .m-strong were already there, just making it
complete with .m-sup, .m-sub and .m-s.

css: explicitly use Python 3.

doxygen: improve type annotations.

That got old fast.

doxygen: properly shown includes for relateds in different files.

doxygen: mention private virtual functions behavior, other doc tweaks.

doxygen: adapt to function declaration location updates in Doxygen 

doxygen: adapt test for features merged to Doxygen 

doxygen: properly prefer shorter prefix.

The prefix_length is usually 0, since it's used for aliases, not
indicating the actual prefix length. So use the whole result length
instead.

doxygen: minor cleanup.

doc: Pelican docs are now https.

Update CONTRIBUTING for future me who will forget how to npm again.

doxygen: make it possible to easily copy result links to clipboard.

Especially Markdown links. A huge timesaver when doing tech support via
Gitter or so :)

doxygen: actually remove the ID attribute instead of emptying it.

doxygen: test the HTML escaping a bit more.

I got confused by how Chrome displays plain text in the developer
console (there's no escaping visible), so extending the test a bit to be
absolutely really sure that it's correct :D

doxygen: don't try to go to the result if there isn't any.

doxygen: autocomplete search input if all results have common prefix.

Handling of truncated UTF-8 was a fun side-task.

doxygen: make it possible to search directly from browser URL bar.

Adds an ability to specify search query by adding ?q={query}#search
to URL, which can be then bookmarked in the browsers to provide search
directly from the URL bar (or search input field).

On browsers supporting OpenSearch discovery (Firefox, Chrome, probably
Edge too), it also provides metadata that allow "single-click" addition
of the search engine to browser's search engine list. This option is
unfortunately well-hidden in the current versions (Firefox has it in the
three-dots menu, in Chrome you need to go to Settings while being on
this page and then it shows a suggestion, wtf). The OpenSearch metadata
are provided through a new opensearch.xml file and referenced from page
<head>. OpenSearch also supports autocompletion and search directly from
browser address bar, but for that to work I would need to implement a
server-side search functionality. Not yet, since I don't have any
immediate plans to turn my cloud file-serving Apache installation into a
smart and vulnerable attack target.

This also wraps the input in a <form>, so browsers not supporting
OpenSearch discovery (Vivaldi) can still add the search engine by
right-clicking on the input field. This works in Firefox as well.
Also, because of the <form> added, Vivaldi started autocompleting crap
suggestions for me, so I had to explicitly disable that.

doxygen: take search query from URL GET ?q= parameter, if present.

doxygen: make it possible to focus the already-shown search input.

For example when going back. Until now I had to use the mouse.

doxygen: hide the search by going back only when it makes sense.

If we landed directly on an URL with #search, going back would mean the
browser is redirected back to the referrer page, the Speed Dial or
whatever. Do not want. In this case we simply replace the history state
without the #search hash -- there definitely wasn't any other hash we
could return to.

doxygen: if the URL already contains #search, hide scrollbar etc.

For consistent experience compared to loading the docs without #search
and then hitting Tab.

doxygen: behave consistently when going back to filled search input.

Not sure why I didn't use the same implementation in both cases.

doxygen: debug output for long-running tasks.

doxygen: disable spell check in the search box.

doxygen: prevent search result being selected before the mouse moves.

Without this, the search was quite unusable with just the keyboard.

doxygen: provide a more meaningful order for results.

Results of the same length are now ordered like this, instead of
appearing in whatever order they were added:

 * Deprecated and deleted symbols are put on the bottom
 * Then ordered by type:
   * First pages, since they usually provide most information
   * Then namespaces and groups
   * Then classes, structs, unions
   * Then functions
   * Then macros
   * Then enums
   * And enum values and variables last
 * After that, items with the shorter suffix (the least amount of
   function arguments) are preferred over longer
 * Finally, items with shorter prefix are preferred over longer (so e.g.
   it shows a Foo in the root namespace over Foo which is 5 levels deep)

This might get fine-tuned later, but I'm already very happy with the
result.

doxygen: swap order of search-related class definitions.

So I can type-annotate better. No functional change.

doxygen: parse override, final and conditional noexcept keywords.

 * override and final is now parsed from function signatures, in the
   theme the [virtual] label gets replaced with either [override] or
   [final], since it doesn't make sense to include both [virtual] and
   [override]/[final] label as the former is implicit for the latter.
 * fixed order of parsing function signature keywords so function
   signatures that are both deleted/defaulted and noexcept are parsed
   correctly instead of noexcept being ignored
 * conditional noexcept is now recognized as well, shown in the theme as
   [noexcept(...)]
 * [final] class specifier is now shown in the class header and also in
   the derived class list
 * [virtual] label is now shown for both virtual base class and
   virtually derived classes to make it symmetric

Updated copyright year.

doxygen: more detailed docs explaining the #include behavior.

And required patches.

doxygen: improve #include information display based on real-world use.

 * In cases where Doxygen spots the namespace first in a *.cpp file (and
   later in a header) but the namespace is still contained in a single
   header, the include informations was improperly put locally into
   members, instead of globally. Now the information is propagated
   upwards from the members to ensure correctness. This needs also
   special handling for namespaces that are otherwise empty, where
   there's nothing that could propagate the info upwards.
 * Complex namespaces (namespaces containing other namespaces or
   classes) no longer have the include information global even though
   the non-class/namespace members are in the same file. This would be
   misleading since inner namespaces and classes are often in different
   files.

doxygen: of course I hit an issue right at the start, so let's test it.

This breaks everything.

Populated CREDITS.md.

doxygen: explicitly write trailing newline to all output files.

Makes test file updates much easier. I need to revisit this later with a
more systematic solution.

doxygen: show corresponding #include files.

This is again a superset of the functionality that stock Doxygen
supports (well of course, I'm full-assing things as usual):

 * Classes (structs, unions) show their corresponding include file right
   in the header (that's what Doxygen does, too)
 * Besides that, namespaces that are fully contained in one file show
   the corresponding include file as well
 * In case of modules (groups) or when namespace contents are spread
   over multiple files, each member shows its own specific include file
   in the detailed docs (because not doing that would be very confusing
   for users, especially if the mapping to files is not trivial). This
   means that functions/enums/typedefs/variables/defines that were
   previously just a brief docs may now get expanded to full docs just
   to contain the include file information. This also unfortunately hits
   a bug in Doxygen, where it doesn't properly report the header
   location for declarations of free (non-member) functions and
   variables (but uses the definition location, which is in most cases
   in an (otherwise undocumented) *.cpp file). I need to report and/or
   PR that, ugh.
 * Files don't provide the include file information, because there it's
   known implicitly.
 * The SHOW_INCLUDE_FILES setting (which defaults to YES and is meant
   to be for "a list of the files that are included by a file in the
   documentation of that file" which is just absolutely fucking useless
   in every way imaginable) is reused to toggle showing of the include
   information.
 * To make the rendering a bit more compact, in case the struct or
   member contains template parameters, the include information is put
   next to these instead of after the signature.
 * As with everything else in m.css, if the corresponding header is not
   documented at all, the include file information is not present.

The \headerfile Doxygen command is not supported, because (what
a surprise! this is totally shitty as well! who would have thought!):

 * it works only for classes, you can't override the include name for
   the file itself!
 * and forget about doing anything like that for free functions,
   typedefs or the like!
 * (minor) it doesn't support #include A_MACRO
 * it doesn't seem to be exposed in the XML at all (ahahahahah AAAARGH)

Co-authored-by: Ryohei Machida <machida_mn@complex.ist.hokudai.ac.jp>

doxygen: print #define detailed description only if actually there.

The detailed docs can contain just parameter docs, for example.

doxygen: support C++14 variable templates.

Interestingly enough, Doxygen already has the support and I just need
some basic template bureaucracy to get it running.

doxygen: minor update to the namespace page template.

There will be an include line added and this is sufficiently
self-contained to commit separately.

doxygen: minor code clarifications.

css: make it possible to have also inline code inverted and highlighted.

More of a hack to support Doxygen theme #include info styling.

doc: forgot to document typedef.has_template_details doxygen template.

Doc++