19 Commits

Author SHA1 Message Date
Andreas Jaeger
64548420c8 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 can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-13 09:48:14 +02:00
Steve Martinelli
b7254b2d83 Update the swift documentation theme
Currently the theme used by the swift developer docs are out of
date, it should be using oslosphinx, to provide a similar look
and feel between all openstack related projects.

Change-Id: Id7c226cdc13c6c4f3b5082b1ef4dfe09966b21ec
2014-08-05 01:01:22 -04:00
annegentle
72428434f7 Replaces Copyright statements for LLC with Foundation, removes date.
Replaced GA code for cross-domain tracking.

Patchset addresses reviewer's comments
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright

Adds current year to each Sphinx-built page.

Addresses only the docs copyright attribution, not code files.

Change-Id: Ib90fd1c92c8fafce2db821bc2b17cef1377cfc1e
2013-02-11 16:32:33 -06:00
Yee
53ab2e150d fix bug1039861, remove license header in doc/source/conf.py.
Change-Id: Iab43ac342faf3722ccab1ed034f08752dbbfaae1
2012-11-11 00:15:39 -08:00
Derek Higgins
387744197e Fixing alterations to sys.path
Fixes bug 1064249

sys.path should be extended not appended to

Change-Id: I3404a50b16b843b47f5082676029a4dd3b03f812
2012-10-09 09:58:06 +01:00
Ray Chen
7ebb81c0f6 Fix PEP8 issues.
Fix a PEP8 issues in doc/source/conf.py to make the code pretty.

Change-Id: I71d36ebb59d44ba145ca13e4f4827139f0466d78
2012-08-22 12:20:30 +08:00
Darrell Bishop
3d3ed34f44 Adding StatsD logging to Swift.
Documentation, including a list of metrics reported and their semantics,
is in the Admin Guide in a new section, "Reporting Metrics to StatsD".
An optional "metric prefix" may be configured which will be prepended to
every metric name sent to StatsD.

Here is the rationale for doing a deep integration like this versus only
sending metrics to StatsD in middleware.  It's the only way to report
some internal activities of Swift in a real-time manner. So to have one
way of reporting to StatsD and one place/style of configuration, even
some things (like, say, timing of PUT requests into the proxy-server)
which could be logged via middleware are consistently logged the same
way (deep integration via the logger delegate methods).

When log_statsd_host is configured, get_logger() injects a
swift.common.utils.StatsdClient object into the logger as
logger.statsd_client.  Then a set of delegate methods on LogAdapter
either pass through to the StatsdClient object or become no-ops. This
allows StatsD logging to look like:
    self.logger.increment('some.metric.here')
and do the right thing in all cases and with no messy conditional logic.

I wanted to use the pystatsd module for the StatsD client, but the
version on PyPi is lagging the git repo (and is missing both the prefix
functionality and timing_since() method).  So I wrote my
swift.common.utils.StatsdClient.  The interface is the same as
pystatsd.Client, but the code was written from scratch.  It's pretty
simple, and the tests I added cover it.  This also frees Swift from an
optional dependency on the pystatsd module, making this feature easier
to enable.

There's test coverage for the new code and all existing tests continue
to pass.

Refactored out _one_audit_pass() method in swift/account/auditor.py and
swift/container/auditor.py.

Fixed some misc. PEP8 violations.

Misc test cleanups and refactorings (particularly the way "fake logging"
is handled).

Change-Id: Ie968a9ae8771f59ee7591e2ae11999c44bfe33b2
2012-05-11 15:25:38 -07:00
John Dickinson
1ecf5ebba1 updated copyright date for all files
Change-Id: Ifd909d3561c2647770a7e0caa3cd91acd1b4f298
2012-03-19 13:45:34 -05:00
Jesse Andrews
62864448bc add git commit date / sha1 to sphinx html docs
Change-Id: If47cee942707d2c36b0b897470b7ec994f0e259a
2012-03-02 16:14:35 -08:00
Anne Gentle
5c4340039d Adding a box to each page that gives readers links to 1.1 and 1.2 Swift docs sites 2011-03-09 23:14:38 -06:00
Anne Gentle
8823427161 Changed copyright notices on py files and the single rst file with a copyright notice 2011-01-04 17:34:43 -06:00
Anne Gentle
4aa104e49e Updated Sphinx theme and index.rst 2010-11-12 12:54:07 -06:00
Anne Gentle
9dc5ffcd07 Adds multi server install doc 2010-11-04 14:25:23 -05:00
Anne Gentle
e03d5bef1f This contains an env variable in conf.py for the build to contain the GA code 2010-10-29 16:30:56 -05:00
Chuck Thier
76002e469f Bumped versioning to 1.1.0, and updated AUTHORS 2010-10-18 15:34:21 +00:00
Monty Taylor
525aee438c Updated sphinx config to match the config from Nova. 2010-07-24 18:03:56 -07:00
Monty Taylor
93925bfe74 Bump tree version post-release. 2010-07-19 11:50:32 -05:00
Monty Taylor
7f105149d6 Bumped version number post 1.0.0 release. 2010-07-18 23:44:19 -05:00
Chuck Thier
001407b969 Initial commit of Swift code 2010-07-12 17:03:45 -05:00