diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2016-06-30 14:00:22 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-06-30 20:58:33 +0200 |
| commit | 0249a764485744b3f5babb02ced0fe6c199d89f7 (patch) | |
| tree | ad2dfeccdf3854119df6e00692190e4d698bb1cf /Documentation/conf.py | |
| parent | Documentation: add meta-documentation for Sphinx and kernel-doc (diff) | |
| download | linux-0249a764485744b3f5babb02ced0fe6c199d89f7.tar.xz linux-0249a764485744b3f5babb02ced0fe6c199d89f7.zip | |
doc-rst: flat-table directive - initial implementation
Implements the reST flat-table directive.
The ``flat-table`` is a double-stage list similar to the ``list-table`` with
some additional features:
* column-span: with the role ``cspan`` a cell can be extended through
additional columns
* row-span: with the role ``rspan`` a cell can be extended through
additional rows
* auto span rightmost cell of a table row over the missing cells on the right
side of that table-row. With Option ``:fill-cells:`` this behavior can
changed from *auto span* to *auto fill*, which automaticly inserts (empty)
list tables
The *list tables* formats are double stage lists. Compared to the
ASCII-art they migth be less comfortable for readers of the
text-files. Their advantage is, that they are easy to create/modify
and that the diff of a modification is much more meaningfull, because
it is limited to the modified content.
The initial implementation was taken from the sphkerneldoc project [1]
[1] https://github.com/return42/sphkerneldoc/commits/master/scripts/site-python/linuxdoc/rstFlatTable.py
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
[jc: fixed typos and misspellings in the docs]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/conf.py')
| -rw-r--r-- | Documentation/conf.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index 6cc41a0555a3..792b6338ef19 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -28,7 +28,7 @@ sys.path.insert(0, os.path.abspath('sphinx')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['kernel-doc'] +extensions = ['kernel-doc', 'rstFlatTable'] # Gracefully handle missing rst2pdf. try: |