Commit Graph

10 Commits

Author SHA1 Message Date
Kefu Chai
a0bdf6932b doc: add ":orphan:" field to avoid sphinx warnings
when building man pages from rst files, sphinx complains if any
rst file is not referenced by a doctree.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:50 +08:00
Kefu Chai
0e07ccc197 man: move man/8/*.rst back to doc/man/8
sphinx requires that a document tree to be in a single directory,
and the man pages are references by our document. so a simple solution
would be to put all the rst file under a single directory.

Fixes: #11320
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:49 +08:00
Kefu Chai
301fe6cbf2 doc: generate man pages in man/Makefile
* move rst files from doc/man/8 into man/8
* extract man_pages setting for sphinx from doc/conf.py to man/conf.py
* generate all man pages in `make install`
* add python-sphinx to Build-Depends
* check for sphinx-build in `configure`
* run changed rst files through sphinx-build in `make check`

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-24 12:36:41 +08:00
Baptiste Veuillez
008698b37c doc: Change Availability text in all of the man pages
http://tracker.ceph.com/issues/5834 fixes:#5834
signed-off-by: Baptiste Veuillez--Mainard <baptiste.veuillez--mainard@telecom-bretagne.eu>
2015-01-22 03:16:35 +01:00
Nilamdyuti Goswami
62b3fcdd24 doc: Updates man page for ceph-disk with suggested changes.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 16:48:50 +05:30
Nilamdyuti Goswami
3f6be22f64 doc: Updates man page for ceph-disk.
Changes format style to improve readability as html.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 16:31:35 +05:30
Nilamdyuti Goswami
8a48847cd4 doc: Updates the man page for ceph-disk utility with some changes.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-26 22:19:01 +05:30
Nilamdyuti Goswami
242dd1c0bb doc: Removes ceph-deploy usage instances from ceph-disk man page.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-25 21:16:16 +05:30
Nilamdyuti Goswami
7dcc85042b doc: Updates man page for ceph-disk utility.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-25 02:06:39 +05:30
Nilamdyuti Goswami
a450cab2b8 doc: Adds man page for ceph-disk utility.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-24 22:05:11 +05:30