19 Commits

Author SHA1 Message Date
Thomas Bechtold
f9503f1a30 Make openstackdocstheme an optional doc dependency
stevedore is a library that is used outside of OpenStack, too. Having
a build requirement that needs something OpenStack specific makes
life in cases (eg. for downstream packagers) more difficult.
So let's make openstackdocstheme an optional requirement.

Change-Id: Ic8cc577e617e5da699f9dc43830183005bd2ee66
2017-08-23 08:31:27 +02:00
Doug Hellmann
7357e8aef0 switch from oslosphinx to openstackdocstheme
Change-Id: I1416bd7e05901dc22f0915af32808ff41ffbb2d0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 13:09:04 -04:00
Doug Hellmann
e758e51871 move documentation into the new standard layout
Change-Id: Id5ae008eab8e52d8943659b809ed1bcd996e0794
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 13:05:57 -04:00
Marianne Linhares
555bc47931 Broken link at stevedore developer documentation
At http://docs.openstack.org/developer/stevedore/
the link about "setuptools entry points" is broken.

Change-Id: I7cfd5af64e83b75f83c6ac0d48bfff2eac3c7435
Closes-bug: #1647151
2016-12-04 12:00:16 -03:00
Andreas Jaeger
0888d13a33 Remove reference to non-existing page
There is no modindex page generated, remove reference to it.

Change-Id: I2707c653ab4c7ab6b13478c5c0da35b82f0b5f65
2016-10-29 13:41:06 +02:00
ChangBo Guo(gcb)
da83cd831d Remove irrelated output item
We register two entry points in sample code, but show three items
in entry_points.txt, just remove it to keep consistent with code.

Change-Id: I7a76c4f23086fe1abdbf7140ba92f97ec1387aed
2016-07-04 03:04:49 +00:00
Bernhard M. Wiedemann
52dfe21ade dont claim copyright for future years
otherwise, when building from unchanged source in 2018,
it would claim Copyright 2018, Dreamhost
which is not true

Change-Id: I5185828a965467ea04033e46a1af2435df4ad760
2016-03-09 11:42:25 +01:00
Marc Koderer
8a19d5fb7b Add a reference to entry_point_inspector
This add a short reference in the install guide
to the entry_point_inspector.

Change-Id: I86f3437949670e75f631319e088321384fe28e42
2016-02-23 14:32:39 +01:00
ChangBo Guo(gcb)
bb73a14d24 Clean up Python 2.6 related stuff
Change-Id: I303465277b30dff66129b6c65112b3e427ee6292
2015-11-26 18:09:38 +08:00
Jenkins
5c28a12b30 Merge "replace the hard-coded history list with an auto-generated one" 2015-09-25 10:48:20 +00:00
Doug Hellmann
d1d63f75b0 Add clarifying language to description of scanning for plugins
Clarify that the python import path is scanned to find packages and
their metadata is examined, so that it is clear that the packages must
be installed in a way that makes them both visible to the same python
interpreter.

Change-Id: I0fc58b3ccc024e209d7f49de7402de67d4437295
2015-09-24 21:12:38 +00:00
Doug Hellmann
e327c8226f Show how to add a plugin in a separate package
One of the most common misconceptions about plugins is that they must be
installed to the same python package as the application. Update the
documentation to provide an explicit example of providing plugins from a
separate package.

Also clean up the package metadata for the existing example to remove
references to URLs and email addresses that no longer work.

Change-Id: I801b6ec3ff287c5342ce63a865167f55d31c78d3
Closes-Bug: #1394393
2015-09-24 19:30:48 +00:00
Doug Hellmann
9d9b4d4210 replace the hard-coded history list with an auto-generated one
Replace the hand curated list of changes with the one generated by pbr
automatically.

At the same time, change the toctree settings in index.rst to avoid
showing every release of stevedore at the top level and to clean up the
amount of nesting showing for other entries.

Change-Id: I3fb9306c0ca3ce6ed9681ffeaa8b9b8ed0f2bd7c
2015-09-24 18:34:11 +00:00
Zhao Lei
02c9e7e144 Fix spelling typo for maunal
occuring -> occurring
for patterns_loading.rst

Plus some source comment spelling fix.

Change-Id: Ia6c79588e70a4150fdcb8e71d14a4bba47a70a23
Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
2015-09-24 13:47:30 +00:00
Thomas Goirand
6ddec6e4c8 Removed non-free color profile from .jpg
All the .jpg files in doc/source/essays had this embedded:
"Copyright 2007 Apple Inc., all rights reserved."

This is an ICC color profile which is copyrighted by Apple
and which is non-free, and may trigger some warnings/errors
by the distribution linters.

This patch converts the .jpg into the sRGB color space. I
did this simply loading the images in GIMP, and exporting
again after accepting the auto-coversion to sRGB.

Change-Id: Ibfdf0828ff149d5c83eb864c4fb854e80868a613
2015-05-31 18:49:36 +02:00
Jenkins
c43bf3b010 Merge "Add sphinx integration" 2015-05-28 01:54:56 +00:00
Doug Hellmann
7295f785f0 Add sphinx integration
Add a restructuredtext directive for documenting a set of plugins with
the needed hooks to make it available is sphinx.

Change-Id: I1a24f9326b4e54174d9dc0ae366315fe29c3ac1b
2015-05-27 23:36:04 +00:00
Davanum Srinivas
2ef21b3210 Fix Python versions supported
We have CI for 2.6, 2.7, 3.4. So make sure
all references to other versions are removed and
all 3 versions above are correctly mentioned where
required.

Make sure we specify 3.4 everywhere needed

Change-Id: I2c90bccfc7495bf8197319196a12b2a8bd0519f1
2015-05-13 11:39:43 -04:00
Doug Hellmann
a322d615db Bring doc build up to standard
Move the requirements definitions and documentation files to the
standard places used by other OpenStack projects so our doc publishing
jobs will work.

Change-Id: Iea630d827976fe517afacf4e373b3a125efff9c9
2014-10-27 08:37:49 -04:00