Commit Graph

15 Commits

Author SHA1 Message Date
Kefu Chai
1dbc932195 doc: use :ref: instead relative path for links
path is fragile when we move the file around, but link is more stable.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-22 01:41:53 +08:00
Courtney Caldwell
ca2261781e
mgr/dashboard/api: generate offline API docs
Generate Sphinx documentation from OpenAPI YAML spec:
- Fixed Docs controller doc generation
- Now dashboard Python doesn't fails if dashboard/frontend/dist doesn't exist
- OpenAPI added to @ceph/api CODEOWNERS
- Renamed Ceph-Dashboard API to Ceph REST or RESTful API.
- OpenAPI Docs: fixed decorators and docstrings.
- Sphinx Docs: updated dashboard and dev ones.

Co-authored-by: Ernesto Puerta <epuertat@redhat.com>
Fixes: https://tracker.ceph.com/issues/45863
Signed-off-by: Courtney Caldwell <ccaldwel@redhat.com>
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2020-09-28 12:03:03 +02:00
Sebastian Wagner
47330807dc doc/api: Add a generated reference of all mon commands.
Generate a ReST document which contains all mon commands.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-05-05 12:51:50 +02:00
Kefu Chai
7357fde070 doc/cephfs: add python binding doc
and restructure cephfs/api to move the javadoc for cephfs to this
directory

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-03-12 18:46:48 +08:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
songweibin
a6b371bea3 doc: correct the path of librbd python APIs
* update the API Documentation page for librbdpy with the
  correct path.
* fix a typo.

Signed-off-by: songweibin <song.weibin@zte.com.cn>
2017-12-27 09:08:12 +08:00
John Spray
0b24c028a2 doc: remove reference to Calamari API
...to avoid confusion wrt new `restful` module.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-06-02 05:01:23 -04:00
Kefu Chai
8fd95430fe doc: add doc for pybind of rgw
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-11-09 21:07:29 +08:00
Alfredo Deza
aec684bfb6 add calamari to the api/index section
Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com>
2014-08-14 10:02:25 -04:00
John Wilkins
51dae8ad7c doc: Updated with glossary terms.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-13 14:09:35 -07:00
John Wilkins
261aaba117 doc: Added entry for the RGW Admin Ops API.
fixes: #5002

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-10 11:30:48 -07:00
John Wilkins
7b96807dfc doc: Added links to APIs.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-16 15:13:57 -08:00
John Wilkins
e3b3108bfd Added the Swift API as is. Still needs a lot of work.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
2012-05-21 17:49:35 -07:00
John Wilkins
f53c8206f8 Minor edits. Still WIP.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:56 -07:00
Tommi Virtanen
afede55c83 Integrate Doxygen into Sphinx docs.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00