70170656fd
- Fix option-describe typos - Correct option and envvar markup, for commands that are using the reference form instead of the definition form or are marking up option arguments as options - Avoid duplicate commands - Fix some invalid docstrings - Fix some invalid indentation - Disable the murano plugin, which has invalid docs - Correct issues with- and track the network-topology spec - Include API modules in docs Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
45 lines
1.3 KiB
ReStructuredText
45 lines
1.3 KiB
ReStructuredText
=============
|
|
Command Specs
|
|
=============
|
|
|
|
Specifications for new commands, objects and actions are listed below.
|
|
These specifications have not been implemented. See
|
|
:doc:`Command List <../command-list>` for implemented commands and
|
|
:doc:`Command Structure <../commands>` for implemented objects and actions.
|
|
|
|
It is optional to propose a specifications patch for new commands,
|
|
objects and actions here before submitting the implementation. Once your
|
|
specifications patch merges then you may proceed with the implementation.
|
|
Your implementation patches should move applicable portions of the
|
|
specifications patch to the official :doc:`Command List <../command-list>`
|
|
and :doc:`Command Structure <../commands>` documentation.
|
|
|
|
Objects Specs
|
|
-------------
|
|
|
|
Add specifications for new objects based on the ``example`` object.
|
|
|
|
Actions Specs
|
|
-------------
|
|
|
|
Add specifications for new actions based on the ``example`` action.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
network-topology
|
|
|
|
Commands Specs
|
|
--------------
|
|
|
|
Add specifications for new commands based on the commands for the
|
|
``example`` object. The ``example`` commands are not intended to
|
|
be a complete template for new commands since other actions, options
|
|
and/or arguments may be used.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 2
|
|
|
|
command-objects/*
|