]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commit
doc: build mon_command_api.rst using a homebrew extension
authorKefu Chai <kchai@redhat.com>
Thu, 7 Jan 2021 15:43:26 +0000 (23:43 +0800)
committerKefu Chai <kchai@redhat.com>
Fri, 8 Jan 2021 03:35:42 +0000 (11:35 +0800)
commit202b805aaf079504a3c8db0eb2a8b14e43fa5bae
treef3e99c3fa0098e288b506b9553d1795de800cca3
parentb84ff2b744f9aa09d3c9d63c672a825fbdb36f8f
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>
admin/build-doc
admin/doc-python-common-requirements.txt
admin/doc-requirements.txt
doc/.gitignore
doc/_ext/ceph_commands.py [new file with mode: 0644]
doc/api/mon_command_api.rst [new file with mode: 0644]
doc/conf.py
doc/scripts/gen_mon_command_api.py [deleted file]
src/script/gen_static_command_descriptions.py [deleted file]