Commit Graph

3 Commits

Author SHA1 Message Date
Kefu Chai
0f2489406a doc/dev: use prompt directive when appropriate
for 2 reasons:

* sphinx renders codeblock using python syntax highlighting by default,
  so it's not surprising that it highlight keywords like "export" in
  command line samples. so to render command line code blocks, we'd
  better specify the syntax explicitly for better rendering result.
* with the help of "prompt" directive, user is able to copy and paste
  the command without the prompt. for instance, with the default
  "::" directive, user will copy "$ ceph df", which is not very
  convenient, but with "prompt" directive, user only copies
  "ceph df".

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-09-05 00:03:52 +08:00
Rishabh Dave
cbcb829575 doc: fix links in developer_guide
Fixes: https://tracker.ceph.com/issues/43663
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-20 11:33:48 +05:30
Rishabh Dave
5f2e33570a doc: split index.rst of dev guide
Move every section to a different file. Also, fix minor issues like
line-wrapping along.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-14 15:12:27 +05:30