chiark / gitweb /
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.
Vladimír Vondruš [Tue, 10 Sep 2019 17:30:09 +0000 (19:30 +0200)]
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.
Vladimír Vondruš [Sun, 8 Sep 2019 11:10:34 +0000 (13:10 +0200)]
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.
Vladimír Vondruš [Fri, 6 Sep 2019 17:12:50 +0000 (19:12 +0200)]
m.sphinx: allow to link to special pages.
Vladimír Vondruš [Fri, 6 Sep 2019 11:52:58 +0000 (13:52 +0200)]
documentation/python: add some TODOs.
Vladimír Vondruš [Fri, 6 Sep 2019 11:52:18 +0000 (13:52 +0200)]
plugins: leave this there commented-out so I don't need to search again.
Vladimír Vondruš [Fri, 6 Sep 2019 11:33:06 +0000 (13:33 +0200)]
m.sphinx: implement a page-wide :ref-prefix: option.
NOW I can start writing real docs without everything being a giant PITA.
Vladimír Vondruš [Fri, 6 Sep 2019 10:30:11 +0000 (12:30 +0200)]
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.
Vladimír Vondruš [Fri, 6 Sep 2019 10:28:34 +0000 (12:28 +0200)]
doc: uh oh.
Vladimír Vondruš [Fri, 6 Sep 2019 10:27:22 +0000 (12:27 +0200)]
Various bits to improve code coverage.
Vladimír Vondruš [Fri, 6 Sep 2019 00:07:51 +0000 (02:07 +0200)]
documentation/python: pull additional stuff from __annotations__.
Vladimír Vondruš [Thu, 5 Sep 2019 22:36:07 +0000 (00:36 +0200)]
documentation/python: include documented underscored names.
Vladimír Vondruš [Thu, 5 Sep 2019 18:20:34 +0000 (20:20 +0200)]
documentation/python: don't die on reST errors in pages.
Vladimír Vondruš [Thu, 5 Sep 2019 18:19:25 +0000 (20:19 +0200)]
documentation/python: this copypaste is like a cancer.
Spreads everywhere.
Vladimír Vondruš [Wed, 4 Sep 2019 18:37:15 +0000 (20:37 +0200)]
documentation/python: avoid blowing up on __name__ not being an attrib.
Don't want to test for this, seems too obscure.
Vladimír Vondruš [Wed, 4 Sep 2019 18:33:36 +0000 (20:33 +0200)]
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?!
Vladimír Vondruš [Wed, 4 Sep 2019 18:28:58 +0000 (20:28 +0200)]
documentation/python: gracefully handle nested annotation parsing failures.
Vladimír Vondruš [Wed, 4 Sep 2019 18:21:43 +0000 (20:21 +0200)]
documentation/python: don't be so enthusiastic with pybind sig matching.
Vladimír Vondruš [Wed, 4 Sep 2019 18:19:50 +0000 (20:19 +0200)]
documentation/python: test for false positives for pybind signatures.
This blows up. Heh.
Vladimír Vondruš [Wed, 4 Sep 2019 18:17:38 +0000 (20:17 +0200)]
documentation/python: try not to use `type` for a variable name.
I wanted to check a type of a variable there.
Vladimír Vondruš [Wed, 4 Sep 2019 18:16:53 +0000 (20:16 +0200)]
documentation/doxygen: don't use entity if it fails to be found.
Vladimír Vondruš [Wed, 4 Sep 2019 18:16:24 +0000 (20:16 +0200)]
m.code: doc++
Be consistent with the actual output.
Vladimír Vondruš [Tue, 3 Sep 2019 21:38:47 +0000 (23:38 +0200)]
m.code: ability to apply filters before/after the code is highlighted.
Vladimír Vondruš [Tue, 3 Sep 2019 19:57:59 +0000 (21:57 +0200)]
plugins: don't implicitly depend on Pelican.
Only when those actually get used from Pelican.
Vladimír Vondruš [Tue, 3 Sep 2019 18:20:01 +0000 (20:20 +0200)]
documentation/python: use an ellipsis for overly large values.
Vladimír Vondruš [Tue, 3 Sep 2019 18:19:28 +0000 (20:19 +0200)]
doc: the Python doc generator is not experimental anymore.
Vladimír Vondruš [Fri, 30 Aug 2019 18:36:10 +0000 (20:36 +0200)]
m.sphinx: ignore duplicate entries in intersphinx inventories.
The "index" is the main offender.
Vladimír Vondruš [Fri, 30 Aug 2019 17:59:08 +0000 (19:59 +0200)]
documentation/python: ensure relative includes work in parsed docs.
This is quite bad, but ... at least something.
Vladimír Vondruš [Fri, 30 Aug 2019 17:10:51 +0000 (19:10 +0200)]
documentation/python: add a NAME_MAPPING config option.
Vladimír Vondruš [Fri, 30 Aug 2019 16:33:05 +0000 (18:33 +0200)]
documentation/python: minor naming cleanup.
Vladimír Vondruš [Fri, 30 Aug 2019 16:26:18 +0000 (18:26 +0200)]
documentation/python, m.sphinx: support for external enum value docs.
Vladimír Vondruš [Fri, 30 Aug 2019 14:13:29 +0000 (16:13 +0200)]
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.
Vladimír Vondruš [Fri, 30 Aug 2019 14:00:00 +0000 (16:00 +0200)]
m.sphinx: extended the section about by-design restrictions.
Vladimír Vondruš [Fri, 30 Aug 2019 12:59:21 +0000 (14:59 +0200)]
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.
Vladimír Vondruš [Fri, 30 Aug 2019 12:47:58 +0000 (14:47 +0200)]
documentation/python: consistently use a single way to render Jinja pages.
Otherwise I forget to specify important variables or do other critical
mistakes.
Vladimír Vondruš [Thu, 29 Aug 2019 08:35:01 +0000 (10:35 +0200)]
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.
Vladimír Vondruš [Wed, 28 Aug 2019 22:43:11 +0000 (00:43 +0200)]
documentation/python: implement a bunch of tricks for attrs.
Workarounds! Hacks! Smelly code!
Vladimír Vondruš [Wed, 28 Aug 2019 22:32:01 +0000 (00:32 +0200)]
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.
Vladimír Vondruš [Wed, 28 Aug 2019 21:58:46 +0000 (23:58 +0200)]
documentation/python: don't forget to handle scope for slots as well.
Vladimír Vondruš [Wed, 28 Aug 2019 20:31:29 +0000 (22:31 +0200)]
m.sphinx: added a :p: role for parameter referencing.
So tiny yet so useful. Doxygen, take a note.
Vladimír Vondruš [Wed, 28 Aug 2019 20:09:37 +0000 (22:09 +0200)]
documentation/python: implement scope enter/exit hooks.
With this we can have relative links for *everything*.
Vladimír Vondruš [Wed, 28 Aug 2019 19:20:04 +0000 (21:20 +0200)]
documentation/python: minor cleanup, naming consistency.