diff options
Diffstat (limited to 'docs/_scripts/siphon_templates/markdown/clicmd')
5 files changed, 136 insertions, 0 deletions
diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md b/docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md new file mode 100644 index 00000000000..de517f160c1 --- /dev/null +++ b/docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md @@ -0,0 +1,15 @@ +{# +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#}
\ No newline at end of file diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/index_header.md b/docs/_scripts/siphon_templates/markdown/clicmd/index_header.md new file mode 100644 index 00000000000..86e5bb6c3e5 --- /dev/null +++ b/docs/_scripts/siphon_templates/markdown/clicmd/index_header.md @@ -0,0 +1,23 @@ +{# +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#} +.. _cmdreference: + +Reference +========= + +.. toctree:: + :maxdepth: 2 + diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/index_section.md b/docs/_scripts/siphon_templates/markdown/clicmd/index_section.md new file mode 100644 index 00000000000..0da934ac938 --- /dev/null +++ b/docs/_scripts/siphon_templates/markdown/clicmd/index_section.md @@ -0,0 +1,16 @@ +{# +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#} + clis/{{ this.page_label(group) }} diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md b/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md new file mode 100644 index 00000000000..f1caa961f56 --- /dev/null +++ b/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md @@ -0,0 +1,62 @@ +{# +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#} +{% set v = item['value'] %} +{% if 'short_help' in v %} +{% set str = v['short_help'] %} +{% set str = this.unescape(str) %} + +{# Summary/usage #} +{{ item['value']['path'] }} +------------------------------------------------------------------------- + +.. code-block:: console + + {{ this.reindent(str, 4) }} + +{% endif %} +{% if 'long_help' in v %} +{% set long_help = v['long_help'] %} +{% set long_help = this.unescape(long_help) %} +{# This is seldom used and will likely be deprecated #} +{# Long help #} +.. code-block:: console + + {{ this.reindent(long_help, 4) }} + +{% endif %} +{% if 'siphon_block' in item['meta'] %} +{% set sb = item["meta"]["siphon_block"] %} +{% set sb = this.process_special(sb) %} +{% if sb %} +{# Extracted from the code in /*? ... ?*/ blocks #} + +{# Description #} + +{{ sb }} +{% endif %} +{% endif %} +{% if 'name' in meta or 'function' in v %} +{# Gives some developer-useful linking #} + +{% if "name" in meta %} +Declaration: ``{{ meta['name'] }}`` `{{ meta["file"] }} line {{ item["meta"]["line_start"] }} <{{ this.repository_link }}{{ meta["file"] }}#L{{ item["meta"]["line_start"] }}>`_ +{% endif %} +{% if "function" in v %} + +Implementation: ``{{ v["function"] }}`` +{% endif %} +{% endif %} + diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/item_header.md b/docs/_scripts/siphon_templates/markdown/clicmd/item_header.md new file mode 100644 index 00000000000..20e4803ec2e --- /dev/null +++ b/docs/_scripts/siphon_templates/markdown/clicmd/item_header.md @@ -0,0 +1,20 @@ +{# +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#} +.. _{{ this.page_label(group) }}: + +=============================================================== +{{ this.page_title(group) }} +=============================================================== |