1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
..
This file is part of m.css.
Copyright © 2017, 2018, 2019, 2020, 2021, 2022, 2023
Vladimír Vondruš <mosra@centrum.cz>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
..
Doc generators
##############
m.css is not just for static sites and blogs --- there's a need for a modern,
lightweight and mobile-friendly layout for API documentation as well. The m.css
documentation generators are defined by their first-class search functionality
and clutter-free output, favoring human-produced documentation over
autogenerated content.
.. button-success:: https://doc.magnum.graphics
Live demo
doc.magnum.graphics
`Features`_
===========
All m.css documentation themes share the following features:
- Modern, lightweight and mobile-friendly HTML5 markup
- Minimalistic design without unnecessary chrome and UI elements
- Focused on presenting the actual written documentation while reducing
questionable auto-generated content
- Math rendered as embedded SVG instead of raster images / MathJax, making
use of the `m.math <{filename}/plugins/math-and-code.rst#math>`_ plugin
- Graphviz / Dot diagrams rendered as embedded SVG, as implemented in
`m.dot <{filename}/plugins/plots-and-graphs.rst#graphs>`_
- Using Pygments for better code highlighting, courtesy of the
`m.code <{filename}/plugins/math-and-code.rst#code>`_ plugin
`Search`_
---------
- Vastly superior search capabilities with immediate feedback
- Search anywhere from a page by opening a popup using a hotkey
- Lookahead with instant feedback without requiring any server-side backend
- Search for symbols using any prefix
- Fully controllable by keyboard
.. image:: {static}/static/opengl-search.png
.. note-success::
If you want to know more, the search functionality implementation and
features are detailed
`in this blog post <https://blog.magnum.graphics/meta/implementing-a-fast-doxygen-search/>`_.
`Doxygen C++ theme » <{filename}/documentation/doxygen.rst>`_
=============================================================
More than just a theme --- taking the XML output produced by Doxygen, cleaning
it up, reducing the autogenerated clutter, while making it mobile-friendly and
extending it with better content layouting capabilities and improved support
for C++11 and beyond. Fully compatible with Doxygen URL format and tag files to
avoid broken links once you switch.
`Python docs » <{filename}/documentation/python.rst>`_
======================================================
All features you're used to from either the m.css Pelican theme or the Doxygen
C++ theme, only for Python documentation. Extracting Python APIs using
reflection, *not* parsing Python sources itself. With dedicated support for
pybind11 projects.
|
