chiark / gitweb /
Vladimír Vondruš [Sun, 7 Jul 2019 10:49:59 +0000 (12:49 +0200)]
documentation/python: properly extract images with complex paths.
The paths are patched to contains just a filename so things like
../../image.png work and don't lead to unreferenceable images. This is
similar to what Doxygen does even though I don't really like that -- it
could lead to conflicting files if there are files with the same
basename.
Vladimír Vondruš [Sun, 7 Jul 2019 09:39:15 +0000 (11:39 +0200)]
plugins: make latex2svg work at least partially with dvisvgm 1.9.2.
Vladimír Vondruš [Tue, 21 May 2019 22:08:19 +0000 (00:08 +0200)]
documentation/python: don't ignore pybind submodules inside packages.
This is extra brittle. Hahah why this has to be so damn complex.
Vladimír Vondruš [Tue, 21 May 2019 18:04:10 +0000 (20:04 +0200)]
documentation/python: use external summary only if it's actually there.
Vladimír Vondruš [Tue, 21 May 2019 14:35:24 +0000 (16:35 +0200)]
m.dot: fix skip message in the test.
Vladimír Vondruš [Sun, 12 May 2019 21:01:10 +0000 (23:01 +0200)]
documentation/python: add support for pre-page and post-run hooks.
Vladimír Vondruš [Sun, 12 May 2019 20:30:56 +0000 (22:30 +0200)]
documentation/python: different order of rendering nested pages.
This should be better for memory usage.
Vladimír Vondruš [Sun, 12 May 2019 20:08:44 +0000 (22:08 +0200)]
m.qr: new plugin for QR code rendering.
Vladimír Vondruš [Sun, 12 May 2019 17:33:19 +0000 (19:33 +0200)]
Doc++
Vladimír Vondruš [Sun, 12 May 2019 17:33:00 +0000 (19:33 +0200)]
doc: link to the Magnum Python docs.
Vladimír Vondruš [Sun, 12 May 2019 17:32:24 +0000 (19:32 +0200)]
documentation/python: copy all referenced images as well.
Vladimír Vondruš [Sun, 5 May 2019 16:10:49 +0000 (18:10 +0200)]
m.sphinx: new plugin for Python docs via external files.
Provides a way to document modules, classes and data in the Python doc
theme.
Vladimír Vondruš [Sun, 12 May 2019 13:58:11 +0000 (15:58 +0200)]
plugins: make it clear the testing is done through Pelican.
Vladimír Vondruš [Tue, 7 May 2019 22:28:24 +0000 (00:28 +0200)]
documentation/python: module tree showed expanders where not needed.
What the heck was I doing there.
Vladimír Vondruš [Tue, 7 May 2019 22:26:21 +0000 (00:26 +0200)]
documentation/python: support more than 9 function overloads.
I thought this time would never come. But here we are, math.dot() needs
this.
Vladimír Vondruš [Tue, 7 May 2019 22:03:47 +0000 (00:03 +0200)]
documentation/python: implement name mapping for _all__.
Basically, if there's this in the code:
from ._native import Foo as PublicName
from ._native import sub as submodule
__all__ = ['PublicName', 'submodule']
then it's clear that the docs should refere library.PublicName and
library.submodule instead of library._native.Foo / library._native.sub.
This mapping is done for both pybind11 signatures and pure Python code.
Vladimír Vondruš [Tue, 7 May 2019 16:27:17 +0000 (18:27 +0200)]
documentation/python: support string annotations.
Vladimír Vondruš [Tue, 7 May 2019 10:35:48 +0000 (12:35 +0200)]
documentation/python: don't cut off the last character in a warning.
I mistakenly thought a[:-1] is the same as a[:]. It isn't.
Vladimír Vondruš [Sun, 5 May 2019 14:05:10 +0000 (16:05 +0200)]
documentation/python: support plugins.
It looks like we're 90% there, hah.
Vladimír Vondruš [Sun, 12 May 2019 14:42:33 +0000 (16:42 +0200)]
documentation/python: introduce the INPUT option for specifying input dir.
Vladimír Vondruš [Sun, 5 May 2019 12:14:23 +0000 (14:14 +0200)]
documentation/python: initial support for documentation pages.
Vladimír Vondruš [Sun, 5 May 2019 12:41:39 +0000 (14:41 +0200)]
documentation/python: don't add implicit INPUT_MODULES in all tests.
Only in the inspect tests, elsewhere it's counterproductive.
Vladimír Vondruš [Sun, 5 May 2019 12:10:19 +0000 (14:10 +0200)]
documentation/python: properly set up everything from m.htmlsanity.
Vladimír Vondruš [Sun, 5 May 2019 14:26:35 +0000 (16:26 +0200)]
m.filesize: minor cleanup.
Vladimír Vondruš [Sun, 5 May 2019 12:13:57 +0000 (14:13 +0200)]
m.htmlsanity: doc++
Vladimír Vondruš [Sun, 5 May 2019 12:12:45 +0000 (14:12 +0200)]
m.htmlsanity: make it possible to compact field lists again.
Do the patching in _SaneFieldBodyTranslator instead, but since both
Pelican theme (which wants field lists uncompacted) and Python docs
(which doesn't) use it, it has to allow another override again.
Vladimír Vondruš [Sun, 5 May 2019 12:06:29 +0000 (14:06 +0200)]
m.htmlsanity: make the docutils settings public.
Vladimír Vondruš [Sat, 4 May 2019 19:47:34 +0000 (21:47 +0200)]
documentation/python: rename brief to summary.
Another doxygen-ism. It made some sense for API docs, but having "brief"
and "description" for pages doesn't make any sense at all. Summary and
content makes much more sense for pages and since it doesn't make sense
to have two types of naming, let's rename it for everything else as
well. This is now also in-line with Pelican article metadata and XMLDoc
for C# docs, yay.
Vladimír Vondruš [Sat, 4 May 2019 19:27:12 +0000 (21:27 +0200)]
documentation/python: properly escape default values.
Vladimír Vondruš [Sat, 4 May 2019 19:22:59 +0000 (21:22 +0200)]
documentation/python: functions actually *can* take args/kwargs directly.
Vladimír Vondruš [Tue, 30 Apr 2019 21:43:50 +0000 (23:43 +0200)]
doc: fix broken anchor.
Vladimír Vondruš [Tue, 30 Apr 2019 21:31:13 +0000 (23:31 +0200)]
doc: another missing reST role.
Vladimír Vondruš [Tue, 30 Apr 2019 21:30:25 +0000 (23:30 +0200)]
m.code: add ZWNJ before ANSI colored squares.
Otherwise it wasn't wrapping even with .m-console-wrap. Not sure why,
<wbr/> didn't work either.
Vladimír Vondruš [Tue, 30 Apr 2019 21:23:51 +0000 (23:23 +0200)]
css: add .m-tiny.
Vladimír Vondruš [Tue, 30 Apr 2019 21:23:24 +0000 (23:23 +0200)]
css: add .m-console-wrap for console output.
Vladimír Vondruš [Mon, 29 Apr 2019 17:28:16 +0000 (19:28 +0200)]
documentation: minor cleanup.
Vladimír Vondruš [Mon, 29 Apr 2019 17:27:02 +0000 (19:27 +0200)]
m.code: rudimentary support for 24bit console colors.
MVP I need for an upcoming article (and docs).
Vladimír Vondruš [Mon, 29 Apr 2019 17:20:51 +0000 (19:20 +0200)]
css: nicely packed code + console figure.
Vladimír Vondruš [Mon, 29 Apr 2019 17:14:45 +0000 (19:14 +0200)]
css: make console output slightly less than pitch black.
I like black coffee and all, but since KDE moved away from #000000 as
well recently, it kinda hurts my eyes now.
Vladimír Vondruš [Mon, 29 Apr 2019 17:12:50 +0000 (19:12 +0200)]
css: consistently use just .m-{code,console}-figure w/o the figure prefix.
This was done in order to make it possible to use code figures with
less-than-ideal authoring tools (Doxygen) and some cases were left out
by accident.
Vladimír Vondruš [Mon, 29 Apr 2019 17:37:40 +0000 (19:37 +0200)]
documentation: whoops, this slipped through when pushing.
Vladimír Vondruš [Mon, 29 Apr 2019 17:37:25 +0000 (19:37 +0200)]
Updated credits.
Cris Luengo [Fri, 26 Apr 2019 04:02:46 +0000 (22:02 -0600)]
Correctly handling <sub>, <sup>, and all HTML entities accepted by Doxygen.
Vladimír Vondruš [Mon, 22 Apr 2019 15:12:46 +0000 (17:12 +0200)]
doc: mention more pybind11 specifics.
Vladimír Vondruš [Sun, 21 Apr 2019 22:05:17 +0000 (00:05 +0200)]
package/ci: set up pybind11 compilation on Travis.
Vladimír Vondruš [Sun, 21 Apr 2019 20:55:40 +0000 (22:55 +0200)]
documentation/python: gracefully handle also crazy return types.
Vladimír Vondruš [Sun, 21 Apr 2019 17:21:40 +0000 (19:21 +0200)]
documentation/python: parsing types of pybind11 properties.
Vladimír Vondruš [Sat, 20 Apr 2019 21:41:31 +0000 (23:41 +0200)]
documentation/python: parse pybind11 function signatures.
Vladimír Vondruš [Sat, 20 Apr 2019 22:07:07 +0000 (00:07 +0200)]
documentation/python: support pybind11-style submodules.
The usual detection fails there. Oh well.
Vladimír Vondruš [Sat, 20 Apr 2019 22:05:14 +0000 (00:05 +0200)]
documentation/python: support pybind11 enums.
Vladimír Vondruš [Sat, 20 Apr 2019 22:03:35 +0000 (00:03 +0200)]
documentation/python: make pybind11 compatibility opt-in.
This is becoming rather shitty.
Vladimír Vondruš [Sat, 20 Apr 2019 18:29:53 +0000 (20:29 +0200)]
documentation/python: module and class index.
Vladimír Vondruš [Sat, 20 Apr 2019 14:47:55 +0000 (16:47 +0200)]
documentation/python: adapt to slightly different internals in 3.6.
Vladimír Vondruš [Sat, 20 Apr 2019 14:10:19 +0000 (16:10 +0200)]
documentation/python: support enums.
Vladimír Vondruš [Fri, 19 Apr 2019 15:47:39 +0000 (17:47 +0200)]
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.
Vladimír Vondruš [Sat, 20 Apr 2019 18:19:54 +0000 (20:19 +0200)]
documentation/doxygen: reflow a comment.
Vladimír Vondruš [Mon, 22 Apr 2019 14:59:40 +0000 (16:59 +0200)]
Doc++
Vladimír Vondruš [Sat, 20 Apr 2019 15:27:40 +0000 (17:27 +0200)]
documentation: ignore more npm cruft.
Vladimír Vondruš [Sat, 20 Apr 2019 15:11:12 +0000 (17:11 +0200)]
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.
Vladimír Vondruš [Fri, 19 Apr 2019 17:51:09 +0000 (19:51 +0200)]
m.alias: remove useless dependency on m.htmlsanity.
Vladimír Vondruš [Fri, 19 Apr 2019 15:22:11 +0000 (17:22 +0200)]
m.htmlsanity: make the plugin usable outside of Pelican.
Vladimír Vondruš [Fri, 19 Apr 2019 17:52:39 +0000 (19:52 +0200)]
documentation/doxygen: use proper CSS color in the test.
Vladimír Vondruš [Fri, 19 Apr 2019 15:52:29 +0000 (17:52 +0200)]
Doc++
Vladimír Vondruš [Wed, 17 Apr 2019 17:23:52 +0000 (19:23 +0200)]
Various updates to the contribution guide.
I spotted a bunch of Engrish and in the end went over everything.
Vladimír Vondruš [Sun, 14 Apr 2019 11:26:24 +0000 (13:26 +0200)]
doxygen: whoops, forgot to update the JS.
Vladimír Vondruš [Wed, 3 Apr 2019 20:13:51 +0000 (22:13 +0200)]
doc: whoops, forgot to commit this.
Vladimír Vondruš [Wed, 3 Apr 2019 15:11:50 +0000 (17:11 +0200)]
doc: fix another order-dependent rst processing error.
Vladimír Vondruš [Wed, 3 Apr 2019 09:16:45 +0000 (11:16 +0200)]
doc: moved sample Doxygen tagfile.
Vladimír Vondruš [Wed, 3 Apr 2019 08:38:52 +0000 (10:38 +0200)]
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
Vladimír Vondruš [Tue, 2 Apr 2019 21:48:31 +0000 (23:48 +0200)]
doc: adapted site to project organization changes.
Vladimír Vondruš [Thu, 3 Jan 2019 20:26:18 +0000 (21:26 +0100)]
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.
Vladimír Vondruš [Tue, 2 Apr 2019 17:33:48 +0000 (19:33 +0200)]
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.
Vladimír Vondruš [Fri, 29 Mar 2019 18:07:40 +0000 (19:07 +0100)]
doxygen: fix namespaced classes with base/derived in the root NS.
Boom. Interesting, no project until now hit this particular case.
Vladimír Vondruš [Fri, 29 Mar 2019 12:25:02 +0000 (13:25 +0100)]
doxygen: avoid showing undocumented enum values twice.
Vladimír Vondruš [Sun, 24 Feb 2019 19:06:36 +0000 (20:06 +0100)]
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.
Vladimír Vondruš [Fri, 29 Mar 2019 09:58:31 +0000 (10:58 +0100)]
doxygen: \code can be also inside \m_span.
Vladimír Vondruš [Sat, 16 Mar 2019 12:44:24 +0000 (13:44 +0100)]
doxygen: *actually* not strip leading whitespace in a block.
The condition was inverted and the test was not testing anything. Ugh.
Vladimír Vondruš [Fri, 29 Mar 2019 10:24:39 +0000 (11:24 +0100)]
oelican-theme: avoid using deprecated PAGINATED_DIRECT_TEMPLATES.
Vladimír Vondruš [Fri, 29 Mar 2019 10:14:50 +0000 (11:14 +0100)]
m.images: make it possible to provide custom titles for image grid.
Vladimír Vondruš [Fri, 29 Mar 2019 10:35:31 +0000 (11:35 +0100)]
m.htmlsanity: graceful docutils error handling in the render_rst filter.
Like I did for Pelican 4.
Vladimír Vondruš [Fri, 29 Mar 2019 10:25:33 +0000 (11:25 +0100)]
m.htmlsanity: don't add an useless class to section titles.
Vladimír Vondruš [Fri, 29 Mar 2019 09:57:02 +0000 (10:57 +0100)]
m.htmlsanity: style footnotes with our CSS classes.
Vladimír Vondruš [Fri, 29 Mar 2019 09:58:58 +0000 (10:58 +0100)]
Doc++
Vladimír Vondruš [Fri, 29 Mar 2019 09:57:36 +0000 (10:57 +0100)]
css: semi-transparent code background also in colored table rows/cells.
Vladimír Vondruš [Fri, 29 Mar 2019 09:56:03 +0000 (10:56 +0100)]
css: styling for footnotes and footnote references.
Vladimír Vondruš [Sat, 23 Feb 2019 00:32:59 +0000 (01:32 +0100)]
Updated .gitignore.
Vladimír Vondruš [Sat, 23 Feb 2019 00:37:36 +0000 (01:37 +0100)]
site: fixes for order-dependent processing, again.
Vladimír Vondruš [Sat, 23 Feb 2019 00:32:43 +0000 (01:32 +0100)]
site: show coverage info in Build Status.
Vladimír Vondruš [Sat, 23 Feb 2019 00:31:15 +0000 (01:31 +0100)]
doxygen: fall back to the default template location from --template.
So people don't need to provide the whole copy, just the modified files.
Vladimír Vondruš [Fri, 22 Feb 2019 23:49:01 +0000 (00:49 +0100)]
doxygen: support the \internal command.
Vladimír Vondruš [Fri, 22 Feb 2019 23:38:34 +0000 (00:38 +0100)]
doxygen: show the final label of a class also in the class tree.
Vladimír Vondruš [Fri, 22 Feb 2019 23:23:43 +0000 (00:23 +0100)]
doxygen: parse function attributes also without leading space.
Vladimír Vondruš [Fri, 22 Feb 2019 22:58:59 +0000 (23:58 +0100)]
doxygen: it gets extra shitty when encountering decltype(auto).
Seriously, is the parser a box full of angry monkeys?! How is this
possible.
Vladimír Vondruš [Fri, 22 Feb 2019 22:22:46 +0000 (23:22 +0100)]
doxygen: more workarounds for insane multiline brief bugs.
Vladimír Vondruš [Fri, 22 Feb 2019 22:21:59 +0000 (23:21 +0100)]
doxygen: treat QT_AUTOBRIEF the same way as JAVA_AUTOBRIEF.
Similar bug ratio.
Vladimír Vondruš [Fri, 22 Feb 2019 21:39:46 +0000 (22:39 +0100)]
doxygen: mention that SHOW_NAMESPACES = NO is not supported.
Vladimír Vondruš [Fri, 22 Feb 2019 21:25:43 +0000 (22:25 +0100)]
doxygen: work around a bug related to HTML <a name=""> anchors.
Consistency FTW. Yay.
Vladimír Vondruš [Fri, 22 Feb 2019 21:05:44 +0000 (22:05 +0100)]
doxygen: harden the "anchor in both group and namespace" test.
Vladimír Vondruš [Fri, 22 Feb 2019 18:00:44 +0000 (19:00 +0100)]
doxygen: support image links.
Yay? Nah. It's still crappy, you still can't have \image inside \ref.
Vladimír Vondruš [Fri, 22 Feb 2019 20:36:05 +0000 (21:36 +0100)]
m.code: don't strip leading whitespace in blocks.