doc: mgr/dashboard: feature-toggles: Fix config

Add '*.inc.rst' to the list of excluded patterns from sphinx-build. This
allows for using '*.inc.rst' as includes, and avoids duplicates. The
benefit of keeping the trailing '.rst' extension is that most IDEs use
that to render reStructured Text files.

Fixes: http://tracker.ceph.com/issues/37530
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>

diff --git a/doc/conf.py b/doc/conf.py
index 45c4604d1b111f64c1c191cabed95bf767190e31..fadb5248a86340143b29fb8854633b627f81b4b9 100644 (file)
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -9,7 +9,7 @@ release = 'dev'
 templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
-exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst']
+exclude_patterns = ['**/.#*', '**/*~', 'start/quick-common.rst', '**/*.inc.rst']
 if tags.has('man'):
     master_doc = 'man_index'
     exclude_patterns += ['index.rst', 'architecture.rst', 'glossary.rst', 'release*.rst',

diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst
index 6172558b18ecc115b69ea361fe1b8f11a679b070..2b504e1d97c81b7e245a9361db6974c26e1d1234 100644 (file)
--- a/doc/mgr/dashboard.rst
+++ b/doc/mgr/dashboard.rst
@@ -769,4 +769,4 @@ Plug-ins
 Dashboard Plug-ins allow to extend the functionality of the dashboard in a modular
 and loosely coupled approach.
 
-.. include:: dashboard_plugins/feature_toggles.rst.inc
+.. include:: dashboard_plugins/feature_toggles.inc.rst

diff --git a/doc/mgr/dashboard_plugins/feature_toggles.inc.rst b/doc/mgr/dashboard_plugins/feature_toggles.inc.rst
new file mode 100644 (file)
index 0000000..bb12aaa
--- /dev/null
+++ b/doc/mgr/dashboard_plugins/feature_toggles.inc.rst
@@ -0,0 +1,44 @@
+.. _dashboard-feature-toggles:
+
+Feature Toggles
+^^^^^^^^^^^^^^^
+
+This plug-in allows to enable or disable some features from the Ceph-Dashboard
+on-demand. When a feature becomes disabled:
+
+- Its front-end elements (web pages, menu entries, charts, etc.) will become hidden.
+- Its associated REST API endpoints will reject any further requests (404, Not Found Error).
+
+The main purpose of this plug-in is to allow ad-hoc customizations of the workflows exposed
+by the dashboard. Additionally, it could allow for dynamically enabling experimental
+features with minimal configuration burden and no service impact.
+
+The list of features that can be enabled/disabled is:
+
+- **Block (RBD)**:
+   - Image Management: ``rbd``
+   - Mirroring: ``mirroring``
+   - iSCSI: ``iscsi``
+- **Filesystem (Cephfs)**: ``cephfs``
+- **Objects (RGW)**: ``rgw`` (including daemon, user and bucket management).
+
+By default all features come enabled.
+
+To retrieve a list of features and their current statuses::
+
+  $ ceph dashboard feature status
+  Feature 'cephfs': 'enabled'
+  Feature 'iscsi': 'enabled'
+  Feature 'mirroring': 'enabled'
+  Feature 'rbd': 'enabled'
+  Feature 'rgw': 'enabled'
+
+To enable or disable the status of a single or multiple features::
+
+  $ ceph dashboard feature disable iscsi mirroring
+  Feature 'iscsi': disabled
+  Feature 'mirroring': disabled
+
+After a feature status has changed, the API REST endpoints immediately respond to
+that change, while for the front-end UI elements, it may take up to 20 seconds to
+reflect it.

diff --git a/doc/mgr/dashboard_plugins/feature_toggles.rst.inc b/doc/mgr/dashboard_plugins/feature_toggles.rst.inc
deleted file mode 100644 (file)
index bb12aaa..0000000
--- a/doc/mgr/dashboard_plugins/feature_toggles.rst.inc
+++ /dev/null
@@ -1,44 +0,0 @@
-.. _dashboard-feature-toggles:
-
-Feature Toggles
-^^^^^^^^^^^^^^^
-
-This plug-in allows to enable or disable some features from the Ceph-Dashboard
-on-demand. When a feature becomes disabled:
-
-- Its front-end elements (web pages, menu entries, charts, etc.) will become hidden.
-- Its associated REST API endpoints will reject any further requests (404, Not Found Error).
-
-The main purpose of this plug-in is to allow ad-hoc customizations of the workflows exposed
-by the dashboard. Additionally, it could allow for dynamically enabling experimental
-features with minimal configuration burden and no service impact.
-
-The list of features that can be enabled/disabled is:
-
-- **Block (RBD)**:
-   - Image Management: ``rbd``
-   - Mirroring: ``mirroring``
-   - iSCSI: ``iscsi``
-- **Filesystem (Cephfs)**: ``cephfs``
-- **Objects (RGW)**: ``rgw`` (including daemon, user and bucket management).
-
-By default all features come enabled.
-
-To retrieve a list of features and their current statuses::
-
-  $ ceph dashboard feature status
-  Feature 'cephfs': 'enabled'
-  Feature 'iscsi': 'enabled'
-  Feature 'mirroring': 'enabled'
-  Feature 'rbd': 'enabled'
-  Feature 'rgw': 'enabled'
-
-To enable or disable the status of a single or multiple features::
-
-  $ ceph dashboard feature disable iscsi mirroring
-  Feature 'iscsi': disabled
-  Feature 'mirroring': disabled
-
-After a feature status has changed, the API REST endpoints immediately respond to
-that change, while for the front-end UI elements, it may take up to 20 seconds to
-reflect it.