RepoMirrors/btrfs-progs
1
0
Fork 0
mirror of https://github.com/kdave/btrfs-progs synced 2025-02-17 02:06:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
d3e7d66ae4
btrfs-progs/Documentation/index.rst

18 lines
242 B
ReStructuredText
Raw Normal View History

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-26 21:06:50 +00:00
.. BTRFS documentation master file
btrfs-progs: docs: add sphinx build support Add basic config and build files for sphinx. The long term plan is to convert all asciidoc sources to ReST and host majority of wiki contents, and maybe more. Build: $ cd Documentation/ $ make -f Makefile.sphinx html The result is in Documentation/_build/html. Signed-off-by: David Sterba <dsterba@suse.com>
2021-10-26 20:48:27 +00:00
Welcome to BTRFS documentation!
===============================
.. toctree::
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-26 21:06:50 +00:00
:maxdepth: 1
btrfs-progs: docs: add sphinx build support Add basic config and build files for sphinx. The long term plan is to convert all asciidoc sources to ReST and host majority of wiki contents, and maybe more. Build: $ cd Documentation/ $ make -f Makefile.sphinx html The result is in Documentation/_build/html. Signed-off-by: David Sterba <dsterba@suse.com>
2021-10-26 20:48:27 +00:00
:caption: Contents:
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-26 21:06:50 +00:00
man-index
btrfs-progs: docs: add sphinx build support Add basic config and build files for sphinx. The long term plan is to convert all asciidoc sources to ReST and host majority of wiki contents, and maybe more. Build: $ cd Documentation/ $ make -f Makefile.sphinx html The result is in Documentation/_build/html. Signed-off-by: David Sterba <dsterba@suse.com>
2021-10-26 20:48:27 +00:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
Reference in New Issue Copy Permalink