diff --git a/doc/source/authentication.rst b/doc/source/cli/authentication.rst similarity index 99% rename from doc/source/authentication.rst rename to doc/source/cli/authentication.rst index be16bd78..5a1d2797 100644 --- a/doc/source/authentication.rst +++ b/doc/source/cli/authentication.rst @@ -1,3 +1,5 @@ +.. _authentication: + ============== Authentication ============== diff --git a/doc/source/backwards-incompatible.rst b/doc/source/cli/backwards-incompatible.rst similarity index 98% rename from doc/source/backwards-incompatible.rst rename to doc/source/cli/backwards-incompatible.rst index 033860d3..571d791f 100644 --- a/doc/source/backwards-incompatible.rst +++ b/doc/source/cli/backwards-incompatible.rst @@ -10,8 +10,8 @@ Should positional arguments for a command need to change, the OpenStackClient team attempts to make the transition as painless as possible. Look for deprecation warnings that indicate the new commands (or options) to use. -Commands labeled as a beta according to :doc:`command-beta` are exempt from -this backwards incompatible change handling. +Commands labeled as a beta according to :ref:`command-beta` are exempt +from this backwards incompatible change handling. Backwards Incompatible Changes ============================== diff --git a/doc/source/command-list.rst b/doc/source/cli/command-list.rst similarity index 84% rename from doc/source/command-list.rst rename to doc/source/cli/command-list.rst index c4045b04..9044f693 100644 --- a/doc/source/command-list.rst +++ b/doc/source/cli/command-list.rst @@ -1,3 +1,5 @@ +.. _command-list: + ============ Command List ============ diff --git a/doc/source/command-objects/access-token.rst b/doc/source/cli/command-objects/access-token.rst similarity index 100% rename from doc/source/command-objects/access-token.rst rename to doc/source/cli/command-objects/access-token.rst diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/cli/command-objects/address-scope.rst similarity index 100% rename from doc/source/command-objects/address-scope.rst rename to doc/source/cli/command-objects/address-scope.rst diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/cli/command-objects/aggregate.rst similarity index 100% rename from doc/source/command-objects/aggregate.rst rename to doc/source/cli/command-objects/aggregate.rst diff --git a/doc/source/command-objects/availability-zone.rst b/doc/source/cli/command-objects/availability-zone.rst similarity index 100% rename from doc/source/command-objects/availability-zone.rst rename to doc/source/cli/command-objects/availability-zone.rst diff --git a/doc/source/command-objects/backup.rst b/doc/source/cli/command-objects/backup.rst similarity index 100% rename from doc/source/command-objects/backup.rst rename to doc/source/cli/command-objects/backup.rst diff --git a/doc/source/command-objects/catalog.rst b/doc/source/cli/command-objects/catalog.rst similarity index 100% rename from doc/source/command-objects/catalog.rst rename to doc/source/cli/command-objects/catalog.rst diff --git a/doc/source/command-objects/command.rst b/doc/source/cli/command-objects/command.rst similarity index 100% rename from doc/source/command-objects/command.rst rename to doc/source/cli/command-objects/command.rst diff --git a/doc/source/command-objects/complete.rst b/doc/source/cli/command-objects/complete.rst similarity index 100% rename from doc/source/command-objects/complete.rst rename to doc/source/cli/command-objects/complete.rst diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/cli/command-objects/compute-agent.rst similarity index 100% rename from doc/source/command-objects/compute-agent.rst rename to doc/source/cli/command-objects/compute-agent.rst diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst similarity index 100% rename from doc/source/command-objects/compute-service.rst rename to doc/source/cli/command-objects/compute-service.rst diff --git a/doc/source/command-objects/configuration.rst b/doc/source/cli/command-objects/configuration.rst similarity index 95% rename from doc/source/command-objects/configuration.rst rename to doc/source/cli/command-objects/configuration.rst index 0e00bbe9..6e704d2d 100644 --- a/doc/source/command-objects/configuration.rst +++ b/doc/source/cli/command-objects/configuration.rst @@ -4,6 +4,8 @@ configuration Available for all services +.. _configuration-show: + configuration show ------------------ diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/cli/command-objects/consistency-group-snapshot.rst similarity index 100% rename from doc/source/command-objects/consistency-group-snapshot.rst rename to doc/source/cli/command-objects/consistency-group-snapshot.rst diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/cli/command-objects/consistency-group.rst similarity index 100% rename from doc/source/command-objects/consistency-group.rst rename to doc/source/cli/command-objects/consistency-group.rst diff --git a/doc/source/command-objects/console-log.rst b/doc/source/cli/command-objects/console-log.rst similarity index 100% rename from doc/source/command-objects/console-log.rst rename to doc/source/cli/command-objects/console-log.rst diff --git a/doc/source/command-objects/console-url.rst b/doc/source/cli/command-objects/console-url.rst similarity index 100% rename from doc/source/command-objects/console-url.rst rename to doc/source/cli/command-objects/console-url.rst diff --git a/doc/source/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst similarity index 100% rename from doc/source/command-objects/consumer.rst rename to doc/source/cli/command-objects/consumer.rst diff --git a/doc/source/command-objects/container.rst b/doc/source/cli/command-objects/container.rst similarity index 100% rename from doc/source/command-objects/container.rst rename to doc/source/cli/command-objects/container.rst diff --git a/doc/source/command-objects/credential.rst b/doc/source/cli/command-objects/credential.rst similarity index 100% rename from doc/source/command-objects/credential.rst rename to doc/source/cli/command-objects/credential.rst diff --git a/doc/source/command-objects/domain.rst b/doc/source/cli/command-objects/domain.rst similarity index 100% rename from doc/source/command-objects/domain.rst rename to doc/source/cli/command-objects/domain.rst diff --git a/doc/source/command-objects/ec2-credentials.rst b/doc/source/cli/command-objects/ec2-credentials.rst similarity index 100% rename from doc/source/command-objects/ec2-credentials.rst rename to doc/source/cli/command-objects/ec2-credentials.rst diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/cli/command-objects/endpoint.rst similarity index 100% rename from doc/source/command-objects/endpoint.rst rename to doc/source/cli/command-objects/endpoint.rst diff --git a/doc/source/command-objects/extension.rst b/doc/source/cli/command-objects/extension.rst similarity index 100% rename from doc/source/command-objects/extension.rst rename to doc/source/cli/command-objects/extension.rst diff --git a/doc/source/command-objects/federation-protocol.rst b/doc/source/cli/command-objects/federation-protocol.rst similarity index 100% rename from doc/source/command-objects/federation-protocol.rst rename to doc/source/cli/command-objects/federation-protocol.rst diff --git a/doc/source/command-objects/flavor.rst b/doc/source/cli/command-objects/flavor.rst similarity index 100% rename from doc/source/command-objects/flavor.rst rename to doc/source/cli/command-objects/flavor.rst diff --git a/doc/source/command-objects/floating-ip-pool.rst b/doc/source/cli/command-objects/floating-ip-pool.rst similarity index 100% rename from doc/source/command-objects/floating-ip-pool.rst rename to doc/source/cli/command-objects/floating-ip-pool.rst diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/cli/command-objects/floating-ip.rst similarity index 100% rename from doc/source/command-objects/floating-ip.rst rename to doc/source/cli/command-objects/floating-ip.rst diff --git a/doc/source/command-objects/group.rst b/doc/source/cli/command-objects/group.rst similarity index 100% rename from doc/source/command-objects/group.rst rename to doc/source/cli/command-objects/group.rst diff --git a/doc/source/command-objects/host.rst b/doc/source/cli/command-objects/host.rst similarity index 100% rename from doc/source/command-objects/host.rst rename to doc/source/cli/command-objects/host.rst diff --git a/doc/source/command-objects/hypervisor-stats.rst b/doc/source/cli/command-objects/hypervisor-stats.rst similarity index 100% rename from doc/source/command-objects/hypervisor-stats.rst rename to doc/source/cli/command-objects/hypervisor-stats.rst diff --git a/doc/source/command-objects/hypervisor.rst b/doc/source/cli/command-objects/hypervisor.rst similarity index 100% rename from doc/source/command-objects/hypervisor.rst rename to doc/source/cli/command-objects/hypervisor.rst diff --git a/doc/source/command-objects/identity-provider.rst b/doc/source/cli/command-objects/identity-provider.rst similarity index 100% rename from doc/source/command-objects/identity-provider.rst rename to doc/source/cli/command-objects/identity-provider.rst diff --git a/doc/source/command-objects/image.rst b/doc/source/cli/command-objects/image.rst similarity index 100% rename from doc/source/command-objects/image.rst rename to doc/source/cli/command-objects/image.rst diff --git a/doc/source/command-objects/ip-availability.rst b/doc/source/cli/command-objects/ip-availability.rst similarity index 100% rename from doc/source/command-objects/ip-availability.rst rename to doc/source/cli/command-objects/ip-availability.rst diff --git a/doc/source/command-objects/ip-fixed.rst b/doc/source/cli/command-objects/ip-fixed.rst similarity index 100% rename from doc/source/command-objects/ip-fixed.rst rename to doc/source/cli/command-objects/ip-fixed.rst diff --git a/doc/source/command-objects/ip-floating-pool.rst b/doc/source/cli/command-objects/ip-floating-pool.rst similarity index 100% rename from doc/source/command-objects/ip-floating-pool.rst rename to doc/source/cli/command-objects/ip-floating-pool.rst diff --git a/doc/source/command-objects/ip-floating.rst b/doc/source/cli/command-objects/ip-floating.rst similarity index 100% rename from doc/source/command-objects/ip-floating.rst rename to doc/source/cli/command-objects/ip-floating.rst diff --git a/doc/source/command-objects/keypair.rst b/doc/source/cli/command-objects/keypair.rst similarity index 100% rename from doc/source/command-objects/keypair.rst rename to doc/source/cli/command-objects/keypair.rst diff --git a/doc/source/command-objects/limits.rst b/doc/source/cli/command-objects/limits.rst similarity index 100% rename from doc/source/command-objects/limits.rst rename to doc/source/cli/command-objects/limits.rst diff --git a/doc/source/command-objects/mapping.rst b/doc/source/cli/command-objects/mapping.rst similarity index 100% rename from doc/source/command-objects/mapping.rst rename to doc/source/cli/command-objects/mapping.rst diff --git a/doc/source/command-objects/module.rst b/doc/source/cli/command-objects/module.rst similarity index 100% rename from doc/source/command-objects/module.rst rename to doc/source/cli/command-objects/module.rst diff --git a/doc/source/command-objects/network-agent.rst b/doc/source/cli/command-objects/network-agent.rst similarity index 100% rename from doc/source/command-objects/network-agent.rst rename to doc/source/cli/command-objects/network-agent.rst diff --git a/doc/source/command-objects/network-auto-allocated-topology.rst b/doc/source/cli/command-objects/network-auto-allocated-topology.rst similarity index 100% rename from doc/source/command-objects/network-auto-allocated-topology.rst rename to doc/source/cli/command-objects/network-auto-allocated-topology.rst diff --git a/doc/source/command-objects/network-flavor-profile.rst b/doc/source/cli/command-objects/network-flavor-profile.rst similarity index 100% rename from doc/source/command-objects/network-flavor-profile.rst rename to doc/source/cli/command-objects/network-flavor-profile.rst diff --git a/doc/source/command-objects/network-flavor.rst b/doc/source/cli/command-objects/network-flavor.rst similarity index 100% rename from doc/source/command-objects/network-flavor.rst rename to doc/source/cli/command-objects/network-flavor.rst diff --git a/doc/source/command-objects/network-meter-rule.rst b/doc/source/cli/command-objects/network-meter-rule.rst similarity index 100% rename from doc/source/command-objects/network-meter-rule.rst rename to doc/source/cli/command-objects/network-meter-rule.rst diff --git a/doc/source/command-objects/network-meter.rst b/doc/source/cli/command-objects/network-meter.rst similarity index 100% rename from doc/source/command-objects/network-meter.rst rename to doc/source/cli/command-objects/network-meter.rst diff --git a/doc/source/command-objects/network-qos-policy.rst b/doc/source/cli/command-objects/network-qos-policy.rst similarity index 100% rename from doc/source/command-objects/network-qos-policy.rst rename to doc/source/cli/command-objects/network-qos-policy.rst diff --git a/doc/source/command-objects/network-qos-rule-type.rst b/doc/source/cli/command-objects/network-qos-rule-type.rst similarity index 100% rename from doc/source/command-objects/network-qos-rule-type.rst rename to doc/source/cli/command-objects/network-qos-rule-type.rst diff --git a/doc/source/command-objects/network-qos-rule.rst b/doc/source/cli/command-objects/network-qos-rule.rst similarity index 100% rename from doc/source/command-objects/network-qos-rule.rst rename to doc/source/cli/command-objects/network-qos-rule.rst diff --git a/doc/source/command-objects/network-rbac.rst b/doc/source/cli/command-objects/network-rbac.rst similarity index 100% rename from doc/source/command-objects/network-rbac.rst rename to doc/source/cli/command-objects/network-rbac.rst diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/cli/command-objects/network-segment.rst similarity index 100% rename from doc/source/command-objects/network-segment.rst rename to doc/source/cli/command-objects/network-segment.rst diff --git a/doc/source/command-objects/network-service-provider.rst b/doc/source/cli/command-objects/network-service-provider.rst similarity index 100% rename from doc/source/command-objects/network-service-provider.rst rename to doc/source/cli/command-objects/network-service-provider.rst diff --git a/doc/source/command-objects/network.rst b/doc/source/cli/command-objects/network.rst similarity index 100% rename from doc/source/command-objects/network.rst rename to doc/source/cli/command-objects/network.rst diff --git a/doc/source/command-objects/object-store-account.rst b/doc/source/cli/command-objects/object-store-account.rst similarity index 100% rename from doc/source/command-objects/object-store-account.rst rename to doc/source/cli/command-objects/object-store-account.rst diff --git a/doc/source/command-objects/object.rst b/doc/source/cli/command-objects/object.rst similarity index 100% rename from doc/source/command-objects/object.rst rename to doc/source/cli/command-objects/object.rst diff --git a/doc/source/command-objects/policy.rst b/doc/source/cli/command-objects/policy.rst similarity index 100% rename from doc/source/command-objects/policy.rst rename to doc/source/cli/command-objects/policy.rst diff --git a/doc/source/command-objects/port.rst b/doc/source/cli/command-objects/port.rst similarity index 100% rename from doc/source/command-objects/port.rst rename to doc/source/cli/command-objects/port.rst diff --git a/doc/source/command-objects/project-purge.rst b/doc/source/cli/command-objects/project-purge.rst similarity index 100% rename from doc/source/command-objects/project-purge.rst rename to doc/source/cli/command-objects/project-purge.rst diff --git a/doc/source/command-objects/project.rst b/doc/source/cli/command-objects/project.rst similarity index 100% rename from doc/source/command-objects/project.rst rename to doc/source/cli/command-objects/project.rst diff --git a/doc/source/command-objects/quota.rst b/doc/source/cli/command-objects/quota.rst similarity index 100% rename from doc/source/command-objects/quota.rst rename to doc/source/cli/command-objects/quota.rst diff --git a/doc/source/command-objects/region.rst b/doc/source/cli/command-objects/region.rst similarity index 100% rename from doc/source/command-objects/region.rst rename to doc/source/cli/command-objects/region.rst diff --git a/doc/source/command-objects/request-token.rst b/doc/source/cli/command-objects/request-token.rst similarity index 100% rename from doc/source/command-objects/request-token.rst rename to doc/source/cli/command-objects/request-token.rst diff --git a/doc/source/command-objects/role-assignment.rst b/doc/source/cli/command-objects/role-assignment.rst similarity index 100% rename from doc/source/command-objects/role-assignment.rst rename to doc/source/cli/command-objects/role-assignment.rst diff --git a/doc/source/command-objects/role.rst b/doc/source/cli/command-objects/role.rst similarity index 100% rename from doc/source/command-objects/role.rst rename to doc/source/cli/command-objects/role.rst diff --git a/doc/source/command-objects/router.rst b/doc/source/cli/command-objects/router.rst similarity index 100% rename from doc/source/command-objects/router.rst rename to doc/source/cli/command-objects/router.rst diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/cli/command-objects/security-group-rule.rst similarity index 100% rename from doc/source/command-objects/security-group-rule.rst rename to doc/source/cli/command-objects/security-group-rule.rst diff --git a/doc/source/command-objects/security-group.rst b/doc/source/cli/command-objects/security-group.rst similarity index 100% rename from doc/source/command-objects/security-group.rst rename to doc/source/cli/command-objects/security-group.rst diff --git a/doc/source/command-objects/server-backup.rst b/doc/source/cli/command-objects/server-backup.rst similarity index 100% rename from doc/source/command-objects/server-backup.rst rename to doc/source/cli/command-objects/server-backup.rst diff --git a/doc/source/command-objects/server-event.rst b/doc/source/cli/command-objects/server-event.rst similarity index 100% rename from doc/source/command-objects/server-event.rst rename to doc/source/cli/command-objects/server-event.rst diff --git a/doc/source/command-objects/server-group.rst b/doc/source/cli/command-objects/server-group.rst similarity index 100% rename from doc/source/command-objects/server-group.rst rename to doc/source/cli/command-objects/server-group.rst diff --git a/doc/source/command-objects/server-image.rst b/doc/source/cli/command-objects/server-image.rst similarity index 100% rename from doc/source/command-objects/server-image.rst rename to doc/source/cli/command-objects/server-image.rst diff --git a/doc/source/command-objects/server.rst b/doc/source/cli/command-objects/server.rst similarity index 100% rename from doc/source/command-objects/server.rst rename to doc/source/cli/command-objects/server.rst diff --git a/doc/source/command-objects/service-provider.rst b/doc/source/cli/command-objects/service-provider.rst similarity index 100% rename from doc/source/command-objects/service-provider.rst rename to doc/source/cli/command-objects/service-provider.rst diff --git a/doc/source/command-objects/service.rst b/doc/source/cli/command-objects/service.rst similarity index 100% rename from doc/source/command-objects/service.rst rename to doc/source/cli/command-objects/service.rst diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/cli/command-objects/snapshot.rst similarity index 100% rename from doc/source/command-objects/snapshot.rst rename to doc/source/cli/command-objects/snapshot.rst diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/cli/command-objects/subnet-pool.rst similarity index 100% rename from doc/source/command-objects/subnet-pool.rst rename to doc/source/cli/command-objects/subnet-pool.rst diff --git a/doc/source/command-objects/subnet.rst b/doc/source/cli/command-objects/subnet.rst similarity index 100% rename from doc/source/command-objects/subnet.rst rename to doc/source/cli/command-objects/subnet.rst diff --git a/doc/source/command-objects/token.rst b/doc/source/cli/command-objects/token.rst similarity index 100% rename from doc/source/command-objects/token.rst rename to doc/source/cli/command-objects/token.rst diff --git a/doc/source/command-objects/trust.rst b/doc/source/cli/command-objects/trust.rst similarity index 100% rename from doc/source/command-objects/trust.rst rename to doc/source/cli/command-objects/trust.rst diff --git a/doc/source/command-objects/usage.rst b/doc/source/cli/command-objects/usage.rst similarity index 100% rename from doc/source/command-objects/usage.rst rename to doc/source/cli/command-objects/usage.rst diff --git a/doc/source/command-objects/user-role.rst b/doc/source/cli/command-objects/user-role.rst similarity index 100% rename from doc/source/command-objects/user-role.rst rename to doc/source/cli/command-objects/user-role.rst diff --git a/doc/source/command-objects/user.rst b/doc/source/cli/command-objects/user.rst similarity index 100% rename from doc/source/command-objects/user.rst rename to doc/source/cli/command-objects/user.rst diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/cli/command-objects/volume-backup.rst similarity index 100% rename from doc/source/command-objects/volume-backup.rst rename to doc/source/cli/command-objects/volume-backup.rst diff --git a/doc/source/command-objects/volume-host.rst b/doc/source/cli/command-objects/volume-host.rst similarity index 100% rename from doc/source/command-objects/volume-host.rst rename to doc/source/cli/command-objects/volume-host.rst diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/cli/command-objects/volume-qos.rst similarity index 100% rename from doc/source/command-objects/volume-qos.rst rename to doc/source/cli/command-objects/volume-qos.rst diff --git a/doc/source/command-objects/volume-service.rst b/doc/source/cli/command-objects/volume-service.rst similarity index 100% rename from doc/source/command-objects/volume-service.rst rename to doc/source/cli/command-objects/volume-service.rst diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/cli/command-objects/volume-snapshot.rst similarity index 100% rename from doc/source/command-objects/volume-snapshot.rst rename to doc/source/cli/command-objects/volume-snapshot.rst diff --git a/doc/source/command-objects/volume-transfer-request.rst b/doc/source/cli/command-objects/volume-transfer-request.rst similarity index 100% rename from doc/source/command-objects/volume-transfer-request.rst rename to doc/source/cli/command-objects/volume-transfer-request.rst diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/cli/command-objects/volume-type.rst similarity index 100% rename from doc/source/command-objects/volume-type.rst rename to doc/source/cli/command-objects/volume-type.rst diff --git a/doc/source/command-objects/volume.rst b/doc/source/cli/command-objects/volume.rst similarity index 100% rename from doc/source/command-objects/volume.rst rename to doc/source/cli/command-objects/volume.rst diff --git a/doc/source/commands.rst b/doc/source/cli/commands.rst similarity index 98% rename from doc/source/commands.rst rename to doc/source/cli/commands.rst index cd71bdc8..5c50a1bf 100644 --- a/doc/source/commands.rst +++ b/doc/source/cli/commands.rst @@ -1,3 +1,5 @@ +.. _command-structure: + ================= Command Structure ================= @@ -162,9 +164,10 @@ referring to both Compute and Volume quotas. Plugin Objects -------------- -The following are known `Objects` used by OpenStack :doc:`plugins`. These are -listed here to avoid name conflicts when creating new plugins. For a complete -list check out :doc:`plugin-commands`. +The following are known `Objects` used by OpenStack +:ref:`plugins`. These are listed here to avoid name +conflicts when creating new plugins. For a complete list check out +:ref:`plugin-commands`. * ``action definition``: (**Workflow Engine (Mistral)**) * ``action execution``: (**Workflow Engine (Mistral)**) @@ -281,7 +284,7 @@ Implementation The command structure is designed to support seamless addition of plugin command modules via ``setuptools`` entry points. The plugin commands must -be subclasses of Cliff's ``command.Command`` object. See :doc:`plugins` for +be subclasses of Cliff's ``command.Command`` object. See :ref:`plugins` for more information. diff --git a/doc/source/data/cinder.csv b/doc/source/cli/data/cinder.csv similarity index 100% rename from doc/source/data/cinder.csv rename to doc/source/cli/data/cinder.csv diff --git a/doc/source/data/glance.csv b/doc/source/cli/data/glance.csv similarity index 100% rename from doc/source/data/glance.csv rename to doc/source/cli/data/glance.csv diff --git a/doc/source/data/keystone.csv b/doc/source/cli/data/keystone.csv similarity index 100% rename from doc/source/data/keystone.csv rename to doc/source/cli/data/keystone.csv diff --git a/doc/source/data/neutron.csv b/doc/source/cli/data/neutron.csv similarity index 100% rename from doc/source/data/neutron.csv rename to doc/source/cli/data/neutron.csv diff --git a/doc/source/data/nova.csv b/doc/source/cli/data/nova.csv similarity index 100% rename from doc/source/data/nova.csv rename to doc/source/cli/data/nova.csv diff --git a/doc/source/data/swift.csv b/doc/source/cli/data/swift.csv similarity index 100% rename from doc/source/data/swift.csv rename to doc/source/cli/data/swift.csv diff --git a/doc/source/decoder.rst b/doc/source/cli/decoder.rst similarity index 100% rename from doc/source/decoder.rst rename to doc/source/cli/decoder.rst diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 00000000..e9aab0af --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,15 @@ +==================== + User Documentation +==================== + +.. toctree:: + :maxdepth: 2 + + Manual Page + command-list + commands + plugin-commands + authentication + interactive + decoder + backwards-incompatible diff --git a/doc/source/interactive.rst b/doc/source/cli/interactive.rst similarity index 100% rename from doc/source/interactive.rst rename to doc/source/cli/interactive.rst diff --git a/doc/source/man/openstack.rst b/doc/source/cli/man/openstack.rst similarity index 99% rename from doc/source/man/openstack.rst rename to doc/source/cli/man/openstack.rst index 66a99f32..ab990979 100644 --- a/doc/source/man/openstack.rst +++ b/doc/source/cli/man/openstack.rst @@ -1,3 +1,5 @@ +.. _manpage: + ==================== :program:`openstack` ==================== @@ -329,7 +331,7 @@ Logging Settings in configuration file. Recording the user operation, it can identify the change of the resource and it becomes useful information for troubleshooting. -See :doc:`../configuration` about Logging Settings for more details. +See :ref:`configuration` about Logging Settings for more details. NOTES diff --git a/doc/source/plugin-commands.rst b/doc/source/cli/plugin-commands.rst similarity index 98% rename from doc/source/plugin-commands.rst rename to doc/source/cli/plugin-commands.rst index ee162f76..55984ffb 100644 --- a/doc/source/plugin-commands.rst +++ b/doc/source/cli/plugin-commands.rst @@ -1,3 +1,5 @@ +.. _plugin-commands: + =============== Plugin Commands =============== diff --git a/doc/source/configuration.rst b/doc/source/configuration/index.rst similarity index 97% rename from doc/source/configuration.rst rename to doc/source/configuration/index.rst index a49f093a..d2b273d7 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration/index.rst @@ -1,3 +1,5 @@ +.. _configuration: + ============= Configuration ============= @@ -22,13 +24,13 @@ names by dropping the ``--os-`` prefix if present. Global Options -------------- -The :doc:`openstack manpage ` lists all of the global +The :ref:`openstack manpage ` lists all of the global options recognized by OpenStackClient and the default authentication plugins. Environment Variables --------------------- -The :doc:`openstack manpage ` also lists all of the +The :ref:`openstack manpage ` also lists all of the environment variables recognized by OpenStackClient and the default authentication plugins. @@ -156,7 +158,7 @@ that appears in :file:`clouds.yaml` Debugging ~~~~~~~~~ -You may find the :doc:`configuration show ` +You may find the :ref:`configuration show ` command helpful to debug configuration issues. It will display your current configuration. diff --git a/doc/source/command-beta.rst b/doc/source/contributor/command-beta.rst similarity index 99% rename from doc/source/command-beta.rst rename to doc/source/contributor/command-beta.rst index 669ef201..40ede671 100644 --- a/doc/source/command-beta.rst +++ b/doc/source/contributor/command-beta.rst @@ -1,3 +1,5 @@ +.. _command-beta: + ============ Command Beta ============ diff --git a/doc/source/command-errors.rst b/doc/source/contributor/command-errors.rst similarity index 100% rename from doc/source/command-errors.rst rename to doc/source/contributor/command-errors.rst diff --git a/doc/source/command-logs.rst b/doc/source/contributor/command-logs.rst similarity index 100% rename from doc/source/command-logs.rst rename to doc/source/contributor/command-logs.rst diff --git a/doc/source/command-options.rst b/doc/source/contributor/command-options.rst similarity index 98% rename from doc/source/command-options.rst rename to doc/source/contributor/command-options.rst index 886c17d2..06623445 100644 --- a/doc/source/command-options.rst +++ b/doc/source/contributor/command-options.rst @@ -14,8 +14,8 @@ for defining and using options in all situations. The alternative of only using it when necessary leads to errors when copy-n-paste is used for a new command without understanding why or why not that instance is correct. -The :doc:`Human Interface Guide ` -describes the guildelines for option names and usage. In short: +The :ref:`hig` describes the guildelines for option names and usage. +In short: * All option names shall be GNU-style long names (two leading dashes). * Some global options may have short names, generally limited to those defined diff --git a/doc/source/command-wrappers.rst b/doc/source/contributor/command-wrappers.rst similarity index 100% rename from doc/source/command-wrappers.rst rename to doc/source/contributor/command-wrappers.rst diff --git a/doc/source/developing.rst b/doc/source/contributor/developing.rst similarity index 100% rename from doc/source/developing.rst rename to doc/source/contributor/developing.rst diff --git a/doc/source/humaninterfaceguide.rst b/doc/source/contributor/humaninterfaceguide.rst similarity index 99% rename from doc/source/humaninterfaceguide.rst rename to doc/source/contributor/humaninterfaceguide.rst index b43c71a9..a7db3800 100644 --- a/doc/source/humaninterfaceguide.rst +++ b/doc/source/contributor/humaninterfaceguide.rst @@ -1,3 +1,5 @@ +.. _hig: + ===================== Human Interface Guide ===================== @@ -202,7 +204,7 @@ dash ('-') to an underscore ('_'), and converting to upper case. ('-') internally between words (:code:`--like-this`). Underscores ('_') shall not be used in option names. * Authentication options conform to the common CLI authentication guidelines in - :doc:`authentication`. + :ref:`authentication`. For example, :code:`--os-username` can be set from the environment via :code:`OS_USERNAME`. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 00000000..4438f2ad --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,16 @@ +=========================== + Contributor Documentation +=========================== + +.. toctree:: + :maxdepth: 1 + + developing + command-beta + command-options + command-wrappers + command-errors + command-logs + specs/commands + plugins + humaninterfaceguide diff --git a/doc/source/plugins.rst b/doc/source/contributor/plugins.rst similarity index 99% rename from doc/source/plugins.rst rename to doc/source/contributor/plugins.rst index 058819a6..13f5d495 100644 --- a/doc/source/plugins.rst +++ b/doc/source/contributor/plugins.rst @@ -1,3 +1,5 @@ +.. _plugins: + ======= Plugins ======= diff --git a/doc/source/specs/command-objects/example.rst b/doc/source/contributor/specs/command-objects/example.rst similarity index 100% rename from doc/source/specs/command-objects/example.rst rename to doc/source/contributor/specs/command-objects/example.rst diff --git a/doc/source/specs/commands.rst b/doc/source/contributor/specs/commands.rst similarity index 78% rename from doc/source/specs/commands.rst rename to doc/source/contributor/specs/commands.rst index 5ae0e840..f9d757e7 100644 --- a/doc/source/specs/commands.rst +++ b/doc/source/contributor/specs/commands.rst @@ -4,15 +4,15 @@ 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. +:ref:`command-list` for implemented commands and +:ref:`command-structure` 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. +specifications patch to the official :ref:`command-list` +and :ref:`command-structure` documentation. Objects Specs ------------- diff --git a/doc/source/specs/network-topology.rst b/doc/source/contributor/specs/network-topology.rst similarity index 100% rename from doc/source/specs/network-topology.rst rename to doc/source/contributor/specs/network-topology.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index ae0ee0ff..be421d20 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,32 +7,19 @@ brings the command set for Compute, Identity, Image, Object Storage and Block Storage APIs together in a single shell with a uniform command structure. -User Documentation ------------------- - -.. toctree:: - :maxdepth: 1 - - Manual Page - command-list - commands - configuration - plugins - plugin-commands - authentication - interactive - humaninterfaceguide - backwards-incompatible +Using OpenStackClient +--------------------- .. toctree:: :maxdepth: 2 - decoder + cli/index + configuration/index Getting Started --------------- -* Try :doc:`some commands ` +* Try :ref:`some commands ` * Read the source `on OpenStack's Git server`_ * Install OpenStackClient from `PyPi`_ or a `tarball`_ @@ -44,19 +31,13 @@ Release Notes Release Notes -Developer Documentation ------------------------ +Contributor Documentation +------------------------- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - developing - command-beta - command-options - command-wrappers - command-errors - command-logs - specs/commands + contributor/index api/modules Project Goals