From 70170656fd4d3c8020391354b13dca63e9e024d1 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Mon, 20 Mar 2017 16:19:27 +0000 Subject: 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 --- doc/source/specs/commands.rst | 7 ++++--- doc/source/specs/network-topology.rst | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) (limited to 'doc/source/specs') 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_topology_show-network +.. _network_topology_show-network: .. describe:: Show network topology for a specific network (name or ID) -- cgit v1.2.1