diff --git a/doc/source/cli/footer.rst b/doc/source/cli/footer.txt similarity index 90% rename from doc/source/cli/footer.rst rename to doc/source/cli/footer.txt index 4e9f9aaf..3f236d09 100644 --- a/doc/source/cli/footer.rst +++ b/doc/source/cli/footer.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + SEE ALSO ======== diff --git a/doc/source/cli/general_options.rst b/doc/source/cli/general_options.txt similarity index 99% rename from doc/source/cli/general_options.rst rename to doc/source/cli/general_options.txt index bc5976e3..0a0f55f2 100644 --- a/doc/source/cli/general_options.rst +++ b/doc/source/cli/general_options.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + **-h, --help** Show the help message and exit diff --git a/doc/source/cli/glanceapi.rst b/doc/source/cli/glanceapi.rst index 75b5d4c6..81a16680 100644 --- a/doc/source/cli/glanceapi.rst +++ b/doc/source/cli/glanceapi.rst @@ -6,7 +6,7 @@ glance-api Server for the Glance Image Service API --------------------------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -23,7 +23,7 @@ OPTIONS **General options** - .. include:: general_options.rst + .. include:: general_options.txt FILES ===== @@ -31,4 +31,4 @@ FILES **/etc/glance/glance-api.conf** Default configuration file for Glance API -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancecachecleaner.rst b/doc/source/cli/glancecachecleaner.rst index 1affa557..e86ced8f 100644 --- a/doc/source/cli/glancecachecleaner.rst +++ b/doc/source/cli/glancecachecleaner.rst @@ -6,7 +6,7 @@ glance-cache-cleaner Glance Image Cache Invalid Cache Entry and Stalled Image cleaner ---------------------------------------------------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -31,7 +31,7 @@ OPTIONS **General options** - .. include:: general_options.rst + .. include:: general_options.txt FILES ===== @@ -39,4 +39,4 @@ FILES **/etc/glance/glance-cache.conf** Default configuration file for the Glance Cache -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancecachemanage.rst b/doc/source/cli/glancecachemanage.rst index 15731284..b8235ab5 100644 --- a/doc/source/cli/glancecachemanage.rst +++ b/doc/source/cli/glancecachemanage.rst @@ -6,7 +6,7 @@ glance-cache-manage Cache management utility ------------------------ -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -78,6 +78,6 @@ OPTIONS **-S STRATEGY, --os-auth-strategy=STRATEGY** Authentication strategy (keystone or noauth) - .. include:: openstack_options.rst + .. include:: openstack_options.txt -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancecacheprefetcher.rst b/doc/source/cli/glancecacheprefetcher.rst index 180d02fc..6750779e 100644 --- a/doc/source/cli/glancecacheprefetcher.rst +++ b/doc/source/cli/glancecacheprefetcher.rst @@ -6,7 +6,7 @@ glance-cache-prefetcher Glance Image Cache Pre-fetcher ------------------------------ -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -24,7 +24,7 @@ OPTIONS **General options** - .. include:: general_options.rst + .. include:: general_options.txt FILES ===== @@ -32,4 +32,4 @@ FILES **/etc/glance/glance-cache.conf** Default configuration file for the Glance Cache -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancecachepruner.rst b/doc/source/cli/glancecachepruner.rst index 910373ce..1bca3316 100644 --- a/doc/source/cli/glancecachepruner.rst +++ b/doc/source/cli/glancecachepruner.rst @@ -6,7 +6,7 @@ glance-cache-pruner Glance cache pruner ------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -25,7 +25,7 @@ OPTIONS **General options** - .. include:: general_options.rst + .. include:: general_options.txt FILES ===== @@ -33,4 +33,4 @@ FILES **/etc/glance/glance-cache.conf** Default configuration file for the Glance Cache -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancecontrol.rst b/doc/source/cli/glancecontrol.rst index b0fe3017..be7848cd 100644 --- a/doc/source/cli/glancecontrol.rst +++ b/doc/source/cli/glancecontrol.rst @@ -6,7 +6,7 @@ glance-control Glance daemon start/stop/reload helper -------------------------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -28,7 +28,7 @@ OPTIONS **General Options** - .. include:: general_options.rst + .. include:: general_options.txt **--pid-file=PATH** File to use as pid file. Default: @@ -50,4 +50,4 @@ OPTIONS **--respawn** Restart service on unexpected death -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancemanage.rst b/doc/source/cli/glancemanage.rst index 9b5e0718..c6cf43ae 100644 --- a/doc/source/cli/glancemanage.rst +++ b/doc/source/cli/glancemanage.rst @@ -6,7 +6,7 @@ glance-manage Glance Management Utility ------------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -85,9 +85,9 @@ OPTIONS **General Options** - .. include:: general_options.rst + .. include:: general_options.txt -.. include:: footer.rst +.. include:: footer.txt CONFIGURATION ============= diff --git a/doc/source/cli/glanceregistry.rst b/doc/source/cli/glanceregistry.rst index 8d664d03..9da18dc5 100644 --- a/doc/source/cli/glanceregistry.rst +++ b/doc/source/cli/glanceregistry.rst @@ -6,7 +6,7 @@ glance-registry Server for the Glance Registry Service -------------------------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -24,7 +24,7 @@ OPTIONS **General options** - .. include:: general_options.rst + .. include:: general_options.txt FILES ===== @@ -32,4 +32,4 @@ FILES **/etc/glance/glance-registry.conf** Default configuration file for Glance Registry -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancereplicator.rst b/doc/source/cli/glancereplicator.rst index 0d471f62..f8a80be4 100644 --- a/doc/source/cli/glancereplicator.rst +++ b/doc/source/cli/glancereplicator.rst @@ -6,7 +6,7 @@ glance-replicator Replicate images across multiple data centers --------------------------------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -82,4 +82,4 @@ OPTIONS **-v, --verbose** Print more verbose output -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/glancescrubber.rst b/doc/source/cli/glancescrubber.rst index 1100ae67..eb1c51df 100644 --- a/doc/source/cli/glancescrubber.rst +++ b/doc/source/cli/glancescrubber.rst @@ -6,7 +6,7 @@ glance-scrubber Glance scrub service -------------------- -.. include:: header.rst +.. include:: header.txt SYNOPSIS ======== @@ -37,7 +37,7 @@ OPTIONS **General options** - .. include:: general_options.rst + .. include:: general_options.txt **-D, --daemon** Run as a long-running process. When not specified (the @@ -55,4 +55,4 @@ FILES **/etc/glance/glance-scrubber.conf** Default configuration file for the Glance Scrubber -.. include:: footer.rst +.. include:: footer.txt diff --git a/doc/source/cli/header.rst b/doc/source/cli/header.txt similarity index 87% rename from doc/source/cli/header.rst rename to doc/source/cli/header.txt index 5a94e030..7c53f12a 100644 --- a/doc/source/cli/header.rst +++ b/doc/source/cli/header.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + :Author: glance@lists.launchpad.net :Date: 2017-09-15 :Copyright: OpenStack Foundation diff --git a/doc/source/cli/openstack_options.rst b/doc/source/cli/openstack_options.txt similarity index 95% rename from doc/source/cli/openstack_options.rst rename to doc/source/cli/openstack_options.txt index 4602bb9a..ad2a858f 100644 --- a/doc/source/cli/openstack_options.rst +++ b/doc/source/cli/openstack_options.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + **-os-auth-token=OS_AUTH_TOKEN** Defaults to env[OS_AUTH_TOKEN] diff --git a/doc/source/user/glanceapi.rst b/doc/source/user/glanceapi.rst index cd5cc7a9..913c773e 100644 --- a/doc/source/user/glanceapi.rst +++ b/doc/source/user/glanceapi.rst @@ -20,7 +20,7 @@ Using Glance's Image Public APIs Glance is the reference implementation of the OpenStack Images API. As such, Glance fully implements versions 1 and 2 of the Images API. -.. include:: deprecation-note.inc +.. include:: ../deprecation-note.inc There used to be a sentence here saying, "The Images API specification is developed alongside Glance, but is not considered part of the Glance project." @@ -127,7 +127,7 @@ See :doc:`authentication` for more information on integrating with Keystone. Using v1.X ---------- -.. include:: deprecation-note.inc +.. include:: ../deprecation-note.inc For the purpose of examples, assume there is a Glance API server running at the URL ``http://glance.openstack.example.org`` on the default port 80.