修订版 | 036f41f846820cd57313583f481e2be7e162c23c (tree) |
---|---|
时间 | 2018-05-12 23:51:07 |
作者 | Albert Mietus < albert AT mietus DOT nl > |
Commiter | Albert Mietus < albert AT mietus DOT nl > |
Added Blog on Sphinx: allDirectives
@@ -0,0 +1,23 @@ | ||
1 | +===================== | |
2 | +All Sphinx Directives | |
3 | +===================== | |
4 | +.. Copyright (C) ALbert Mietus, 2018 | |
5 | + | |
6 | +.. post:: 2018/05/12 | |
7 | + :category: Sphinx | |
8 | + :tags: Sphinx directives | |
9 | + | |
10 | + `Sphinx <http:\\Sphinx-doc.org>`_ comes with a huge number of *directives*. Some are inherited from `RST | |
11 | + <http://docutils.sourceforge.net/rst.html>`_, others come from the many extensions that are available. But the is no | |
12 | + list of all, or the most used directives in Sphinx. | |
13 | + | |
14 | + Until now ... | |
15 | + | |
16 | +The most used directives to document Sphinx itself | |
17 | +================================================== | |
18 | + | |
19 | +With a simple iPython-script, I counted all directives in all (`.rst` & `.py`) files of `Sphinx-doc | |
20 | +<https://github.com/sphinx-doc/sphinx.git>`_ (*the latest version, on May 10, 2018*); 1758 in total. The table below | |
21 | +shows them all, sorted in most-used-order. As you can seem many directives are only used once (`0.06%`) or twice ... | |
22 | + | |
23 | +.. include:: SphinxDoc-table.inc |
@@ -0,0 +1,41 @@ | ||
1 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
2 | +| Directive | % | Directive | % | Directive | % | Directive | % | | |
3 | ++====================+========+====================+========+====================+========+====================+========+ | |
4 | +| ``versionadded`` | 17.35% | ``event`` | 1.14% | ``moduleauthor`` | 0.28% | ``attention`` | 0.11% | | |
5 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
6 | +| ``confval`` | 14.39% | ``autofunction`` | 1.14% | ``digraph`` | 0.28% | ``object`` | 0.11% | | |
7 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
8 | +| ``versionchanged`` | 6.88% | ``math`` | 1.14% | ``autoexception`` | 0.28% | ``todolist`` | 0.11% | | |
9 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
10 | +| ``automethod`` | 4.89% | ``image`` | 1.08% | ``important`` | 0.28% | ``cmdoption`` | 0.11% | | |
11 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
12 | +| ``option`` | 4.32% | ``figure`` | 1.08% | ``contents`` | 0.23% | ``tabularcolumns`` | 0.11% | | |
13 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
14 | +| ``autoattribute`` | 4.10% | ``index`` | 1.08% | ``include`` | 0.23% | ``directivename`` | 0.06% | | |
15 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
16 | +| ``toctree`` | 3.53% | ``function`` | 1.02% | ``glossary`` | 0.23% | ``testsetup`` | 0.06% | | |
17 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
18 | +| ``note`` | 2.90% | ``autosummary`` | 1.02% | ``sourcecode`` | 0.23% | ``graph`` | 0.06% | | |
19 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
20 | +| ``data`` | 2.84% | ``seealso`` | 0.91% | ``graphviz`` | 0.23% | ``sidebar`` | 0.06% | | |
21 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
22 | +| ``autoclass`` | 2.84% | ``warning`` | 0.91% | ``ifconfig`` | 0.23% | ``centered`` | 0.06% | | |
23 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
24 | +| ``module`` | 2.67% | ``todo`` | 0.74% | ``cssclass`` | 0.17% | ``hlist`` | 0.06% | | |
25 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
26 | +| ``class`` | 1.93% | ``method`` | 0.74% | ``autodata`` | 0.17% | ``sectionauthor`` | 0.06% | | |
27 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
28 | +| ``attribute`` | 1.93% | ``automodule`` | 0.68% | ``doctest`` | 0.17% | ``productionlist`` | 0.06% | | |
29 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
30 | +| ``literalinclude`` | 1.65% | ``describe`` | 0.51% | ``testcode`` | 0.17% | ``caution`` | 0.06% | | |
31 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
32 | +| ``highlight`` | 1.59% | ``raw`` | 0.46% | ``testoutput`` | 0.17% | ``danger`` | 0.06% | | |
33 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
34 | +| ``only`` | 1.59% | ``admonition`` | 0.46% | ``topic`` | 0.11% | ``error`` | 0.06% | | |
35 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
36 | +| ``rubric`` | 1.54% | ``program`` | 0.46% | ``tip`` | 0.11% | ``staticmethod`` | 0.06% | | |
37 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
38 | +| ``deprecated`` | 1.42% | ``table`` | 0.40% | ``exception`` | 0.11% | ``userdesc`` | 0.06% | | |
39 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
40 | +| ``currentmodule`` | 1.14% | ``hint`` | 0.34% | ``envvar`` | 0.11% | ``meta`` | 0.06% | | |
41 | ++--------------------+--------+--------------------+--------+--------------------+--------+--------------------+--------+ | |
\ No newline at end of file |
@@ -0,0 +1,15 @@ | ||
1 | +.. _Sphinx-: | |
2 | + | |
3 | +Sphinx-doc (& ReStructuredText) | |
4 | +=============================== | |
5 | +.. Copyright (C) ALbert Mietus, 2018 | |
6 | + | |
7 | +`Sphinx <http:\\Sphinx-doc.org>`_ and `reStructuredText (RST) <http://docutils.sourceforge.net/rst.html>`_ are | |
8 | +great. And there is a lot of documentation for it too. But still, I’m missing some. So I will write it myself | |
9 | + | |
10 | +.. toctree:: | |
11 | + :maxdepth: 2 | |
12 | + :glob: | |
13 | + | |
14 | + * | |
15 | + |