diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2017-03-20 16:19:27 +0000 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2017-03-28 16:41:54 +0100 |
| commit | 70170656fd4d3c8020391354b13dca63e9e024d1 (patch) | |
| tree | c9ba08521eba6a19c44cf50d1e6d7756f22ba65e /doc/source/specs | |
| parent | 9f471eede95b7c555c4b71673806bd11943460e0 (diff) | |
| download | python-openstackclient-70170656fd4d3c8020391354b13dca63e9e024d1.tar.gz | |
doc: Correct Sphinx warnings
- 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
Diffstat (limited to 'doc/source/specs')
| -rw-r--r-- | doc/source/specs/commands.rst | 7 | ||||
| -rwxr-xr-x | doc/source/specs/network-topology.rst | 2 |
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/source/specs/commands.rst b/doc/source/specs/commands.rst index 55bf9476..5ae0e840 100644 --- a/doc/source/specs/commands.rst +++ b/doc/source/specs/commands.rst @@ -19,14 +19,15 @@ Objects Specs Add specifications for new objects based on the ``example`` object. -* ``example``: (**example API name**) example object description - Actions Specs ------------- Add specifications for new actions based on the ``example`` action. -* ``example`` - example action description +.. toctree:: + :maxdepth: 1 + + network-topology Commands Specs -------------- diff --git a/doc/source/specs/network-topology.rst b/doc/source/specs/network-topology.rst index a0218a1e..6789ee97 100755 --- a/doc/source/specs/network-topology.rst +++ b/doc/source/specs/network-topology.rst @@ -38,7 +38,7 @@ Show network topology details openstack network topology show <network> -.. _network_topology_show-network +.. _network_topology_show-network: .. describe:: <network> Show network topology for a specific network (name or ID) |