RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-30 07:23:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
124,249 Commits 210 Branches 394 Tags 1.4 GiB
ac7ab31ef6
Commit Graph

42 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
Kefu Chai
925c4d8d04 doc/_ext: add python_path option to ceph-mgr-commands 
so we can add more python paths in addition to the one used for finding
mgr modules.

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2021-01-15 17:25:27 +08:00
Kefu Chai
202b805aaf doc: build mon_command_api.rst using a homebrew extension 
so we can build the command doc using ReadTheDoc infra, without adding
the generated rst file to the source repo.

before this change, all the commands are ordered alphabetically. after
this change, command docs are generated by two directives, and are
ordered separately. we could restructure the directives and merge them.

but let's leave it for a future change if this is important.

for more details on writing sphinx directives, see
https://www.sphinx-doc.org/en/master/extdev/markupapi.html and
https://docutils.sourceforge.io/docs/howto/rst-directives.html

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2021-01-08 11:35:42 +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
Patrick Donnelly
df62f2d91d
qa: remove libcephfs-java tests 
These have bit-rotted and no longer work. No cycles from interested parties
available to fix.

Fixes: https://tracker.ceph.com/issues/38487
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
 2019-02-28 13:32:15 -08: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
9ea2609ea0 doc: Added libcephfs to the CephFS section and moved librbd to RBD section. 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-11-16 14:56:46 -08:00
John Wilkins
5c302ebbd7 doc: Move of cluster ops for new IA. 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-11-14 14:55:29 -08:00
Noah Watkins
e225767384 doc: add JavaDoc to Sphinx 
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
 2012-10-26 10:28:50 -07:00
John Wilkins
0be2611158 doc: Published RADOS GW docs and install as is for now. Needs more work. 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-06-26 08:21:05 -07:00
John Wilkins
fb6ea82f40 doc: Added S3 examples to the toctree. 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-06-05 11:09:44 -07:00
Emily Popper
62fe9f42a6 doc: adding code samples for S3 API usage (thanks, DH!) 
Signed-off-by: Ross Turk <ross@inktank.com>
 2012-06-05 10:55:08 -07:00
John Wilkins
6dd93b9a97 doc: Updated authentication with header canonicalization. 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-05-30 10:14:30 -07:00
John Wilkins
73e29b658d doc: needed carriage returns between headings, code tag and syntax. 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-05-25 16:15:14 -07:00
John Wilkins
68874afaaa doc: Filled in descriptions for object operations. 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-05-25 16:03:02 -07:00
Dan Mick
6e46de3703 rbd.py doc: Fix markup on :class: references 
Signed-off-by: Dan Mick <dan.mick@inktank.com>
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
 2012-05-23 19:33:19 -07:00
John
09192d6597 doc/api/s3/bucketops.rst Corrected heading. 
doc/install/chef.rst  Added Sam's edits to the Chef install.


Signed-off-by: John <john@admin-host.(none)>
 2012-05-23 16:12:06 -07:00
John
3956cb8f19 doc/api/s3 <-chipping away at objectops and clean up. Added Copy Object. 
doc/source <-fixed a typo, updates for installing on precise, rm $ from cmds
doc/start  <-replaced clone link with tarball link. Link to Ceph Source Code.


Signed-off-by: John Wilkins <john.wilkins@inktank.com>
 2012-05-23 15:44:11 -07: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
Josh Durgin
572c756036 doc: fix sizes in librbd python examples 
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
 2012-05-17 13:56:32 -07:00
Greg Farnum
48d97fe796 doc: add ioctx parameter to rbd pybind examples. 
This parameter is required and was missing. And fix a typo
 2012-05-16 13:43:12 -07:00
Tommi Virtanen
5465e81097 doc: Whitespace cleanup. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2012-05-03 10:15:21 -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
John Wilkins
33dc4c2636 The new files contain S3 APIs and a build from source doc. 
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2012-05-02 12:09:55 -07:00
Sage Weil
57f52479a9 doc: disable broken 'doxygenclass' class in librados c++ doc 
This is the last remaining gitbuilder error.  Add it back when the C++
docs actually build.

Signed-off-by: Sage Weil <sage@newdream.net>
 2012-04-03 09:06:37 -07:00
Josh Durgin
9490b36e07 doc: add librados C aio example 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-09 19:10:11 -08:00
Tommi Virtanen
c960641666 doc: Switch doxygen integration from breathe to asphyxiate. 
TODO: path of librados.h is now just the basename

TODO: no enum support for now

TODO: no @bug support for now

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2012-01-09 19:03:56 -08:00
Josh Durgin
b5759df82c doc: add configuration and connecting to librados C api example 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-09 19:03:56 -08:00
Josh Durgin
43952a3bcf doc: add librados C api docs 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-09 19:03:56 -08:00
Mark Kampe
30def38d21 corrected variable (con) to be consistent with prior examples (cluster) 
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-11-23 15:56:52 -08:00
Josh Durgin
c00e06f697 doc: add documentation for librbd python bindings 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2011-09-30 11:37:15 -07:00
Tommi Virtanen
3144fd73d9 doc: Flesh out librados API example, to show doxygen & sphinx integration. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-08-30 12:37:12 -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