chiark / gitweb /
Vladimír Vondruš [Mon, 8 Jun 2020 20:49:03 +0000 (22:49 +0200)]
documentation/doxygen: haha what.
Vladimír Vondruš [Mon, 8 Jun 2020 20:48:00 +0000 (22:48 +0200)]
documentation/doxygen: clarify a bunch of things.
Vladimír Vondruš [Mon, 8 Jun 2020 20:27:22 +0000 (22:27 +0200)]
documentation/doxygen: reduce boilerplate in the tests.
Followup to
5eb113bae33b05701b8e213d2400298ada29138e.
Vladimír Vondruš [Mon, 8 Jun 2020 19:51:20 +0000 (21:51 +0200)]
Updated CREDITS.rst.
Blair Conrad [Thu, 21 May 2020 12:46:57 +0000 (08:46 -0400)]
m.code: revamp ANSI color code handling completely.
Co-authored-by: Sergei Izmailov <sergei.a.izmailov@gmail.com>
Vladimír Vondruš [Mon, 8 Jun 2020 19:35:29 +0000 (21:35 +0200)]
m.code: remove the ZWNJ hack.
Was used only to fix one browser rendering issue on magnum.graphics
which happened only when Unicode blocks were involved. Does not make
sense to pollute all output with it.
Vladimír Vondruš [Mon, 8 Jun 2020 19:33:28 +0000 (21:33 +0200)]
documentation/doxygen: detach the console highlighting symlink.
The ANSI lexer is getting a massive update, and we don't need to test
the whole thing twice.
Vladimír Vondruš [Mon, 8 Jun 2020 18:42:34 +0000 (20:42 +0200)]
m.code: add .. code-block:: and .. sourcecode:: aliases.
Vladimír Vondruš [Mon, 8 Jun 2020 18:23:21 +0000 (20:23 +0200)]
doc: yet another order-dependent generation issue.
Vladimír Vondruš [Mon, 8 Jun 2020 16:46:39 +0000 (18:46 +0200)]
Updated credits.
Yuri Edward [Tue, 12 May 2020 19:53:02 +0000 (21:53 +0200)]
documentation/doxygen: fixed bug with exception references.
Vladimír Vondruš [Mon, 8 Jun 2020 16:36:47 +0000 (18:36 +0200)]
documentation/python: prefix an internal utility function.
Sergei Izmailov [Sat, 16 May 2020 14:33:51 +0000 (17:33 +0300)]
documentation/python: add Iterable to recognized typing types.
Sergei Izmailov [Sat, 16 May 2020 00:42:35 +0000 (03:42 +0300)]
documentation/python: make `parse_pybind_type` more permissive.
pybind11 has some non-standard typing-like annotations, e.g.:
List[List[float[3]][3]] for std::array<std::array<float,3>,3>
Sergei Izmailov [Fri, 15 May 2020 22:34:30 +0000 (01:34 +0300)]
documentation/python: improve pybind11 default argument parsing.
Vladimír Vondruš [Sun, 7 Jun 2020 15:50:53 +0000 (17:50 +0200)]
documentation/doxygen: switch to a config supplied from a Python file.
Keeping full backwards compatibility with the original Doxyfile names,
except for template files which now have to use the new values.
Vladimír Vondruš [Sun, 7 Jun 2020 11:18:39 +0000 (13:18 +0200)]
doc: clarify some more Doxygen (mis)behavior.
Vladimír Vondruš [Sun, 7 Jun 2020 11:04:25 +0000 (13:04 +0200)]
Updated copyright year.
Sergei Izmailov [Sat, 16 May 2020 01:05:45 +0000 (04:05 +0300)]
Fix typo
Vladimír Vondruš [Thu, 14 May 2020 12:06:44 +0000 (14:06 +0200)]
Updated CREDITS.rst.
Lukas Pirl [Wed, 13 May 2020 08:57:48 +0000 (10:57 +0200)]
pelican-theme: wrap page/article content in blocks.
For easier extension/customization/overriding of templates.
Vladimír Vondruš [Thu, 14 May 2020 10:50:44 +0000 (12:50 +0200)]
m.code: add a bunch of advanced .. include:: features.
It was already useful, but this makes it even more. What's done:
- :start-on: so it's possible to pin on something in the code without
having to add a comment marker everywhere
- :end-before: that can be empty, and thus simply stop at the end of
the block
- :strip-prefix: for removing excessive indentation as well as adding
an ability to interpret code comments as reST.
All combined together, one can now embed Sphinx Gallery files (which can
be converted to ipynb files too) *and* still have a total flexibility
over what's done on the content formatting and layouting side, ignoring
boring portions of the source file etc etc.
Vladimír Vondruš [Thu, 14 May 2020 09:02:25 +0000 (11:02 +0200)]
m.code: take over the whole .. include:: directive.
Until now it was overriding it only if the :code: option was present,
but I need to extend it also for direct include, so copying over the
whole implementation from docutils. And removing the :encoding:,
:literal: and :name: options as I don't see any use for them nowadays.
Vladimír Vondruš [Thu, 14 May 2020 10:47:41 +0000 (12:47 +0200)]
doc: mention the :filters: option earlier.
Vladimír Vondruš [Tue, 12 May 2020 08:31:13 +0000 (10:31 +0200)]
documentation/doxygen: support CSS classes on table cells.
Finally.
Vladimír Vondruš [Wed, 13 May 2020 10:56:43 +0000 (12:56 +0200)]
Revert "wrap page/article content in blocks"
It's actually completely broken, GitHub led me to a false sense of
security by showing a green tick.
This reverts commit
4d1a78e9707fe52676074e600289e770a17720d8.
Lukas Pirl [Wed, 13 May 2020 08:57:48 +0000 (10:57 +0200)]
wrap page/article content in blocks
for easier extension/customization/overriding of templates
Vladimír Vondruš [Tue, 12 May 2020 07:38:39 +0000 (09:38 +0200)]
documentation/python: parametrize tests with search data version.
Vladimír Vondruš [Tue, 12 May 2020 07:12:55 +0000 (09:12 +0200)]
doc: fix a path.
Vladimír Vondruš [Tue, 12 May 2020 07:12:03 +0000 (09:12 +0200)]
documentation: improve search short data test to depend on header size.
So when we move to bigger types, it still catches outdated assumptions.
Vladimír Vondruš [Tue, 12 May 2020 06:56:01 +0000 (08:56 +0200)]
documentation: calculate the result index differently.
Vladimír Vondruš [Tue, 12 May 2020 06:43:01 +0000 (08:43 +0200)]
documentation: reduce magic constants in search implementation a bit.
Vladimír Vondruš [Mon, 11 May 2020 12:45:38 +0000 (14:45 +0200)]
documentation/python: ignore more stuff added by typing.
Vladimír Vondruš [Mon, 11 May 2020 11:05:57 +0000 (13:05 +0200)]
documentation/python: ignore __next_in_mro__ under Py3.6.
Vladimír Vondruš [Mon, 11 May 2020 10:25:00 +0000 (12:25 +0200)]
documentation/python: repro case for another Py3.6-specific typing thing.
Vladimír Vondruš [Mon, 11 May 2020 09:58:15 +0000 (11:58 +0200)]
documentation/python: improve the Py3.6-specific _gorg workaround.
This should fix the assert reproduced by the previous commit, though the
__next_in_mro__ still needs to be ignored.
Vladimír Vondruš [Mon, 11 May 2020 10:06:57 +0000 (12:06 +0200)]
documentation/python: avoid aliasing the type() builtin.
Vladimír Vondruš [Mon, 11 May 2020 08:17:48 +0000 (10:17 +0200)]
documentation/python: a futile attempt to improve a firing assert.
Continuation of
f45a8b060c5cd875da1fe66982025627c2747359.
Vladimír Vondruš [Mon, 11 May 2020 09:17:50 +0000 (11:17 +0200)]
documentation/python: attempt to reproduce a Py3.6-specific typing issue.
Vladimír Vondruš [Mon, 11 May 2020 09:08:50 +0000 (11:08 +0200)]
documentation/doxygen: if the thing crashes, I'd like to be informed.
Otherwise people blame me, and not Doxygen.
Vladimír Vondruš [Fri, 8 May 2020 15:01:01 +0000 (17:01 +0200)]
templates: use an empty alt for navbar brand image.
Helps screen readers (and textual browsers) ignore the image as
non-essential. Another variant would be putting some text there, but
since the brand name is right after, it would be superfluous, not
giving any additional information.
Vladimír Vondruš [Fri, 8 May 2020 14:49:03 +0000 (16:49 +0200)]
m.htmlsanity: apply .m-link-wrap to plain URL links.
Vladimír Vondruš [Fri, 8 May 2020 14:13:20 +0000 (16:13 +0200)]
css: add .m-link-wrap class for wrapping long link URLs.
And add actual docs mentioning various wrapping methods.
Vladimír Vondruš [Fri, 8 May 2020 13:41:48 +0000 (15:41 +0200)]
Update CREDITS.md.
Marr11317 [Thu, 9 Apr 2020 22:47:00 +0000 (18:47 -0400)]
documentation/doxygen: do not show Doxygen version 0 on empty index.
Co-authored-by: Vladimír Vondruš <mosra@centrum.cz>
Vladimír Vondruš [Thu, 7 May 2020 21:42:05 +0000 (23:42 +0200)]
documentation/python: more graceful handling of duplicate classes.
Not ideal (as the resulting docs are confusing), but at least something.
Creating two copies of the same class could easily lead to infinite
recursion in code paths that don't expect it, so not doing that.
Vladimír Vondruš [Thu, 7 May 2020 20:10:58 +0000 (22:10 +0200)]
documentation/python: deterministic formatting of function values.
Otherwise it would be a different hash every time.
Vladimír Vondruš [Thu, 7 May 2020 20:07:19 +0000 (22:07 +0200)]
documentation/python: dedicated test for value formatting.
Vladimír Vondruš [Thu, 7 May 2020 19:00:38 +0000 (21:00 +0200)]
documentation/doxygen: create the output dir because Doxygen is stupid.
It can't create nested directories.
Vladimír Vondruš [Thu, 7 May 2020 18:11:24 +0000 (20:11 +0200)]
Adapt to matplotlib output changes as well.
Vladimír Vondruš [Thu, 7 May 2020 15:10:47 +0000 (17:10 +0200)]
Yet another variant of a graphviz dot output.
Vladimír Vondruš [Thu, 7 May 2020 17:22:09 +0000 (19:22 +0200)]
documentation/doxygen: avoid useless detailed docs in some cases.
If a class was spread over more files (either because of related
functions or because Doxygen bugs) and SHOW_INCLUDE_FILES was disabled
or the file was not documented, the detailed docs contained nothing
except brief, being useless. Do not add them in that case.
Vladimír Vondruš [Thu, 7 May 2020 15:41:49 +0000 (17:41 +0200)]
documentation/doxygen: don't warn about _EXPORT / _LOCAL.
Magnum-specific, was added at a time when this wasn't used anywhere
else. It doesn't make sense to have this here, as every project would
need a different set of checks. Could be doable externally via various
hooks, removing this for now.
Vladimír Vondruš [Thu, 7 May 2020 15:32:21 +0000 (17:32 +0200)]
documentation/doxygen: support colspan/rowspan in tables.
New in 1.8.18.
Vladimír Vondruš [Thu, 7 May 2020 17:26:34 +0000 (19:26 +0200)]
package/ci: use doxygen 1.8.17.
1.8.16 and older got deleted from there, so there's no other option
anyway. OTOH 1.8.18 doesn't work on Ubuntu 16.04 anymore (FFS) so I have
to stay on 1.8.17.
Vladimír Vondruš [Thu, 7 May 2020 16:11:47 +0000 (18:11 +0200)]
documentation/doxygen: can't keep up with the bugs.
Now there's a superfluous static in the function return type. (Yes, the
hash difference is due to this. Yes, I smelled the regression
correctly.)
Vladimír Vondruš [Thu, 7 May 2020 15:24:26 +0000 (17:24 +0200)]
documentation/doxygen: it calculates a hash of this func differently now.
Um. I smell a hidden bug or A REGRESSION INCOMING.
Vladimír Vondruš [Thu, 7 May 2020 14:57:07 +0000 (16:57 +0200)]
documentation/doxygen: 1.8.18 parses Markdown differently, it seems.
Better, even. Unheard of.
Vladimír Vondruš [Thu, 7 May 2020 14:16:36 +0000 (16:16 +0200)]
documentation/doxygen: thanks for this bug also.
Vladimír Vondruš [Thu, 7 May 2020 14:01:56 +0000 (16:01 +0200)]
documentation/doxygen: thanks for new bugs, 1.8.17.
Vladimír Vondruš [Thu, 7 May 2020 11:28:48 +0000 (13:28 +0200)]
documentation/doxygen: it no longer produces an empty graph here.
Okay, I guess.
Vladimír Vondruš [Thu, 7 May 2020 11:28:11 +0000 (13:28 +0200)]
documentation/doxygen: drop handling for a Doxygen 1.8.15 bug.
Vladimír Vondruš [Thu, 5 Dec 2019 19:05:26 +0000 (20:05 +0100)]
doc update the Pygments CSS generation snippet for Py 3.8.
Vladimír Vondruš [Thu, 5 Dec 2019 19:04:53 +0000 (20:04 +0100)]
css: fix a typo in the CSS file.
Sorry if this broke your things.
Vladimír Vondruš [Thu, 5 Dec 2019 19:01:29 +0000 (20:01 +0100)]
css: update console theme to match updated KDE's Breeze.
It has a slightly better contrast and not so oversaturated colors, being
easier on the eyes. The previous one was also based off KDE, but they
updated it since.
Vladimír Vondruš [Thu, 5 Dec 2019 18:49:06 +0000 (19:49 +0100)]
m.code: improve ANSI coloring to work on ASan output as well.
Vladimír Vondruš [Mon, 25 Nov 2019 17:09:02 +0000 (18:09 +0100)]
documentation/python: fix a cyclic crawl corner case in Python 3.6.
Vladimír Vondruš [Mon, 25 Nov 2019 16:59:25 +0000 (17:59 +0100)]
documentation/python: attempt to reproduce a Py3.6-specific issue.
DarkContact [Wed, 20 Nov 2019 16:51:44 +0000 (19:51 +0300)]
fix typo "pygments-dark" -> "pygments-console"
DarkContact [Tue, 19 Nov 2019 19:09:03 +0000 (22:09 +0300)]
fix encoding
Vladimír Vondruš [Tue, 19 Nov 2019 18:11:46 +0000 (19:11 +0100)]
Updated CREDITS.rst.
DarkContact [Tue, 19 Nov 2019 17:28:12 +0000 (20:28 +0300)]
fix compile on windows (with code page 1251)
Vladimír Vondruš [Sat, 16 Nov 2019 22:45:14 +0000 (23:45 +0100)]
documentation/doxygen: support \since as labels in entry lists.
Makes everything much easier to discover. Since I'm by far no longer the
only user, I have a fear of breaking things, so this is completely
opt-in.
Also recognizes a combination of \since and \deprecated as "a version in
which given API got deprecated", expanding the red deprecated label with
a custom text.
Vladimír Vondruš [Sat, 16 Nov 2019 22:41:23 +0000 (23:41 +0100)]
documentation/doxygen: support adding classes to \ref.
Andy Kluger [Fri, 25 Oct 2019 16:35:03 +0000 (12:35 -0400)]
Fix typo "make advantage" -> "take advantage"
Cris Luengo [Sat, 19 Oct 2019 05:38:24 +0000 (23:38 -0600)]
documentation: Added support for strikethrough markdown formatting
in Doxygen documentation (`~~`).
Vladimír Vondruš [Wed, 2 Oct 2019 17:26:15 +0000 (19:26 +0200)]
pelican-theme: I thought the M_HTML_HEADER option was there always.
But apparently not.
Vladimír Vondruš [Fri, 27 Sep 2019 18:19:09 +0000 (20:19 +0200)]
documentation: fix a crashy corner case with the typing module.
WHY IS IT SUCH A DUMPSTER FIRE
Vladimír Vondruš [Sun, 15 Sep 2019 19:49:25 +0000 (21:49 +0200)]
documentation: save 0.6 kB per page by optimizing the magnifier SVG.
I should have used <use> since the beginning, heh. The magnifier is now
exported with Inkscape with just 3 significant decimal places (instead
of 5) and that's apparently more than enough.
Vladimír Vondruš [Sun, 15 Sep 2019 19:34:22 +0000 (21:34 +0200)]
documentation/python, m.sphinx: support documenting raised exceptions.
Vladimír Vondruš [Sun, 15 Sep 2019 19:26:57 +0000 (21:26 +0200)]
m.sphinx: improve docs in various places.
Vladimír Vondruš [Sun, 15 Sep 2019 15:57:20 +0000 (17:57 +0200)]
documentation/python: clean up and fix property doc extraction.
Now it's no early returns, making the docstring parsing less
duplicated, and also fixing the problem with slots/attrs/getset things
not being exposed to search.
Vladimír Vondruš [Sun, 15 Sep 2019 15:53:25 +0000 (17:53 +0200)]
documentation/python: test that a slot is properly added to search.
It's not because extract_property_doc() has a few early returns that
fail to execute the search-adding code.
Vladimír Vondruš [Sun, 15 Sep 2019 14:48:47 +0000 (16:48 +0200)]
doc: i wrote this half asleep, apparently.
Vladimír Vondruš [Thu, 12 Sep 2019 20:57:40 +0000 (22:57 +0200)]
documentation/python: this should be checking for subtitle, actually.
Otherwise it prints None there and that's everything but desired.
Vladimír Vondruš [Thu, 12 Sep 2019 20:56:40 +0000 (22:56 +0200)]
documentation/doxygen: well, whatever.
This is a weird quirk of the Doxyfile parsing. I don't care, actually.
Not worth spending time on. Put quotes around.
Vladimír Vondruš [Thu, 12 Sep 2019 20:54:33 +0000 (22:54 +0200)]
Support navbar project / brand logo in all three themes.
Vladimír Vondruš [Thu, 12 Sep 2019 19:51:04 +0000 (21:51 +0200)]
css: add styling for brand logo in the navbar.
Interesting, I added support for this into the Pelican theme at the
very beginning, but didn't actually get to styling or testing it at
all.
Vladimír Vondruš [Thu, 12 Sep 2019 19:29:03 +0000 (21:29 +0200)]
doc: various minor improvements.
Vladimír Vondruš [Thu, 12 Sep 2019 19:28:10 +0000 (21:28 +0200)]
css: support .m-badge on standalone images as well.
Vladimír Vondruš [Thu, 12 Sep 2019 19:04:19 +0000 (21:04 +0200)]
css: deduplicate block/inline styling.
Vladimír Vondruš [Wed, 11 Sep 2019 10:56:03 +0000 (12:56 +0200)]
css: make it possible to control console color directly.
Having it the same as --code-color makes it impossible to have dark
console listings combined with light code listings. Also while at it,
made .m-inverted line highlighting work with console listings too.
This has a minor visual change for for higlighted .m-inverted lines --
probably by accident those were not reverted back to --code-color, but
rather --color, making them darker than they should be in the dark
theme.
Vladimír Vondruš [Wed, 11 Sep 2019 10:52:26 +0000 (12:52 +0200)]
css: make it possible to specify a different color for header breadcrumb.
With brightly-colored headers the usual dim color doesn't make sense.
No visual change to the builtin themes, only adding flexibility for 3rd
party styles.
Vladimír Vondruš [Wed, 11 Sep 2019 10:50:56 +0000 (12:50 +0200)]
css: style search background separately from the header navbar.
Otherwise it's too much of a pain with bright-colored headers. No
visual change to the builtin themes, just adding flexibility for 3rd
party ones.
Vladimír Vondruš [Tue, 10 Sep 2019 20:34:11 +0000 (22:34 +0200)]
documentation/python: create output dir for each file if not exists.
Otherwise an URL_FORMATTER putting things into subdirs won't really
work.
Vladimír Vondruš [Tue, 10 Sep 2019 20:06:27 +0000 (22:06 +0200)]
documentation/python: extend URL_FORMATTER also to static data.
Vladimír Vondruš [Tue, 10 Sep 2019 17:47:43 +0000 (19:47 +0200)]
m.sphinx: add an option to repack a decompressed inventory file.
Vladimír Vondruš [Tue, 10 Sep 2019 17:44:53 +0000 (19:44 +0200)]
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.
Vladimír Vondruš [Tue, 10 Sep 2019 17:42:50 +0000 (19:42 +0200)]
m.sphinx: ensure fully qualified name links always have a precedence.
The previously added test now passes.
Vladimír Vondruš [Tue, 10 Sep 2019 17:37:17 +0000 (19:37 +0200)]
documentation/python: test that fully qualified links get a precedence.
They don't, unfortunately.