35 Commits

Author SHA1 Message Date
Andreas Jaeger
85e5b93918 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This causes docs jobs to fail because we error out on warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-12 22:47:21 +02:00
Dirk Mueller
69df886b76 Switch over to oslosphinx
oslosphinx is the new name of oslo.sphinx

Closes-Bug: #1277168
Change-Id: I8aa08e3e16d46209b9aeb20a70b3984b2a4ae5bb
2014-02-14 16:31:46 +01:00
Matt Fischer
8f1c1b1a3b Update all the glance manpages
Finish updating the glance manpages:
  - Update and modernize all files and references
  - Add a new manpage for glance-replicator
  - Move the common configuration options to common files for
    easier maintenance and less redundancy

Change-Id: If2cbcc30f2761b187038f39324c7698de4eb2ab9
Closes-Bug: #1238366
2014-01-26 06:48:05 -07:00
Jakub Ruzicka
07d06ebfc4 Remove glance CLI man page.
glanceclient CLI man page is provided by glanceclient.

Fixes bug 1212300

Change-Id: I61f61b50cb74d71331fadb89659a3cee2b13a359
2013-08-14 17:04:44 +02:00
Doug Hellmann
670b07eb56 Use oslo.sphinx and remove local copy of doc theme
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.

blueprint oslo.sphinx

Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
2013-07-05 16:10:20 -04:00
John Bresnahan
039f3d8a59 Convert scripts to entry points
The executable programs used by Glance have historically been scripts
in the ./bin directory.  This patch converts all of the scripts to
entry_points.  This change makes these programs python modules.  Thus
they can be imported and methods in them can be called just like any
other module.  This will allow the tests to call into these programs
directly instead of having to fork out a process.

The conf.py file in the doc tree was causing a name collision with
the python module cmd.  The glance/glance directory was being added
to sys.path which made glance.cmd import with the name cmd.  This
patch also fixes that problem.

blueprint: refactoring-better-faster-stronger-functional-tests
Change-Id: I67ae14b7403af31a5944befcd2ec27a690e81f15
2013-04-29 14:08:29 -10:00
annegentle
a2b9bed75d Updates OpenStack LLC with OpenStack Foundation
Patchset addresses reviewer's comments, rebase against master,
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright

Change-Id: I94367461505778973528eb8835d991f4fb796dab
2013-02-17 19:19:43 -08:00
Jenkins
926823c14c Merge "Remove autodoc and useless index docs" 2012-08-28 06:39:44 +00:00
Ray Chen
dcca6cd96c PEP8 fix in conf.py
Fix PEP8 issues in doc/source/conf.py.

Change-Id: Ia35ad77af3c74ffd4c67bc6eef662b038937fdad
2012-08-23 16:00:22 +08:00
Brian Waldon
11a9a4847c Remove autodoc and useless index docs
* Remove autodoc sphinx extension
* Ignore auto-generated 'api' docs
* Prevent the corresponding 'api' index from being created
* Prevent an empty 'index' page from getting generated

Related to bp glance-folsom-docs-cleanup

Change-Id: I82c9389f884ea4af853f1215731c051d1fb596e8
2012-08-22 18:45:44 -07:00
Monty Taylor
014d3f9ee3 Move to tag-based versioning.
* Update to latest openstack-common setup code
* Add openstack-common version module

Change-Id: Id6876b55554c358fbd29e7ef8377f42a72a98301
2012-08-12 16:10:03 +00:00
Paul McMillan
86eb836685 Minor grammar corrections.
Fix its/it's, clarify a few other wordings.

Change-Id: I4459e72e79caf84f4c69378cf20f7c443cf48b97
2012-04-10 12:54:12 -07:00
Brian Waldon
d453def814 Remove glance-cache-queue-image
* bin/glance-cache-queue-image duplicates functionality provided by
  bin/ glance-cache-manage, and it is currently broken. Let's just remove it.

Change-Id: Ib18be2116055154047df6ca9b4c335323c8b2dde
2012-03-15 14:26:59 -07:00
Brian Waldon
f1bc67c24b Remove todolist from docs
* Fixes bug 954543

Change-Id: Ib6ca8bbed18f1967108825b8b219a7d46336d11d
2012-03-14 14:02:16 -07:00
Jesse Andrews
c6a626e243 add git commit date / sha1 to sphinx html docs
Change-Id: I9f92a459fbf83bb42ff2fa31c2fb9c09372c8138
2012-03-02 16:03:22 -08:00
Russell Bryant
58532a4373 Add more man pages.
A few man pages were already in place.  This patch uses the --help
output from each executable to seed a man page for the rest of the
executables, which include:

  - glance
  - glance-cache-cleaner
  - glance-cache-manage
  - glance-cache-prefetcher
  - glance-cache-pruner
  - glance-cache-queue-image
  - glance-control
  - glance-scrubber

Fixes bug 911291.

Change-Id: Ie0de990ff6617e7eb953f270a089c99bc340b4fe
2012-01-03 19:23:44 -05:00
Pádraig Brady
03372c77aa Bug#894027: use correct module when building docs
Currently the wrong directory is searched for the
glance module, requiring glance to be installed
in the default system path, for docs to be buildable.
Also the path was appended, so the default system version
which may be completely different is referenced.
This ensures that only local glance files are referenced.

Change-Id: Ia226c90bbd24d7804401a7c9e444387c78a0f542
2011-11-23 15:24:52 +00:00
Rick Harris
0236aea227 Adding some basic documentation 2011-02-02 06:53:05 +00:00
jaypipes@gmail.com
7d314e6039 Merge Bexar r56 2011-01-27 14:01:02 -06:00
jaypipes@gmail.com
00ac0d44a6 Makes Glance's versioning non-static. Uses Nova's versioning scheme. 2011-01-27 13:59:49 -06:00
Cerberus
0c93176178 Adds/updates the copyright info on most of the files in glance and copies over the Authors check from Nova. 2011-01-27 17:57:34 +00:00
jaypipes@gmail.com
c3ed035bbf Bump version 2011-01-26 19:17:54 -06:00
Cerberus
7a5b5016ee Merge conflicts and merge from trunk 2011-01-26 14:47:01 -06:00
Cerberus
2c7f6ff811 Merge prop fixes and a few missed things 2011-01-26 14:44:36 -06:00
Josh Kearney
f536fdd8f3 PEP8 cleanup 2011-01-26 10:51:08 -06:00
jaypipes@gmail.com
a8d791c2d7 Adds architecture docs and enables Graphviz sphinx extension. Also cleans up source code formatting in docs. 2011-01-26 16:01:48 +00:00
jaypipes@gmail.com
4675f0618d Bump version 2011-01-25 11:02:07 -06:00
Cerberus
3cf3746739 Pylint cleanup 2011-01-24 16:18:06 -06:00
jaypipes@gmail.com
5a74a85f94 Adds architecture docs and enables Graphviz sphinx extension. Also cleans up source code formatting in docs. 2011-01-24 13:03:20 -05:00
jaypipes@gmail.com
cd15f14fc8 Version bump after release 2011-01-24 09:57:49 -05:00
jaypipes@gmail.com
02781962a4 Version bump for release 2011-01-23 13:03:51 -05:00
jaypipes@gmail.com
c967f9ace2 Adds man pages for glance-registry and glance-api. Adds Getting Started guide to Glance docs. 2011-01-19 16:38:39 -05:00
Cory Wright
386b42c176 More PEP8 fixes 2011-01-04 17:00:37 -05:00
jaypipes@gmail.com
2406386809 Update sphinx conf to match other OpenStack projects 2010-12-22 12:52:15 -05:00
Monty Taylor
3d69f40135 Added setup.py and sphinx docs. 2010-09-26 00:25:34 -07:00