btrfs-progs/Documentation/index.rst
David Sterba 4110fbc46f btrfs-progs: docs: add sample RSTified manual page
The asciidoc format needs to be tweaked but otherwise is basically the
same. Changes:

- bold text is ** **
- italics is * *
- NOTE is directive .. note
- definition list is simple indented block after the term
- section NAME in the manual page is generated from date in
  conf.py:man_pages
- new page has to be added to the index

To do:

- references to other manual pages, will be RST native linking once all
  the pages are converted

The output is in Documentation/_build/man and the format is visually not
much different from what is generated by asciidoc.

Signed-off-by: David Sterba <dsterba@suse.com>
2021-10-29 17:30:03 +02:00

18 lines
242 B
ReStructuredText

.. BTRFS documentation master file
Welcome to BTRFS documentation!
===============================
.. toctree::
:maxdepth: 1
:caption: Contents:
man-index
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`