]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
mgr/dashboard/api: generate offline API docs 36016/head
authorCourtney Caldwell <ccaldwel@redhat.com>
Tue, 8 Sep 2020 15:06:33 +0000 (11:06 -0400)
committerErnesto Puerta <epuertat@redhat.com>
Mon, 28 Sep 2020 10:03:03 +0000 (12:03 +0200)
commitca2261781ec5a55e9130f0c40a947e131c061712
treed4dcf75ae65396253a7b14ce7f0dcd8f5e491da6
parentfa83dbd76e15a3f326b7b2c2e21eeeea68e33c44
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>
23 files changed:
.github/CODEOWNERS
admin/doc-requirements.txt
doc/api/index.rst
doc/conf.py
doc/dev/developer_guide/dash-devel.rst
doc/mgr/ceph_api/index.rst [new file with mode: 0644]
doc/mgr/dashboard.rst
doc/mgr/index.rst
src/pybind/mgr/dashboard/CMakeLists.txt
src/pybind/mgr/dashboard/__init__.py
src/pybind/mgr/dashboard/controllers/__init__.py
src/pybind/mgr/dashboard/controllers/cephfs.py
src/pybind/mgr/dashboard/controllers/docs.py
src/pybind/mgr/dashboard/controllers/home.py
src/pybind/mgr/dashboard/controllers/orchestrator.py
src/pybind/mgr/dashboard/controllers/rbd.py
src/pybind/mgr/dashboard/controllers/settings.py
src/pybind/mgr/dashboard/controllers/telemetry.py
src/pybind/mgr/dashboard/controllers/user.py
src/pybind/mgr/dashboard/openapi.yaml [new file with mode: 0644]
src/pybind/mgr/dashboard/requirements-extra.txt [new file with mode: 0644]
src/pybind/mgr/dashboard/requirements.txt
src/pybind/mgr/dashboard/tox.ini