14 Commits

Author SHA1 Message Date
Joe Gordon
3ceeb134d3 Add link to readme at bottom of docs.openstack.org/developer/hacking/
The readme has important information so we want to make it discoverable
at http://docs.openstack.org/developer/hacking/
Remove 'Further Reading' section in HACKING.rst since it's already in
the README.rst which is now linked at the bottom of
http://docs.openstack.org/developer/hacking/

Change-Id: I45c51494382283003f61fc416953a576efa7db60
2014-05-06 12:25:06 -07:00
Joe Gordon
5d7d7342d9 Cleanup hacking doc generation
* Delete old layout files now that we use oslosphinx
* Add fail to build on warning
* Add 'tox -edoc' command (just like nova-specs, keystone, heat etc)

Change-Id: I316c4bb3fe7036ecd8a0fb19d7348c307c0afebe
2014-04-25 14:13:33 -07:00
Dirk Mueller
f487cff435 Switch over to oslosphinx
oslosphinx is the new name of oslo.sphinx

Change-Id: I70ac51fcd7148832f94b7aae5049893bc650846d
Closes-Bug: #1277168
2014-02-14 18:52:42 +01:00
Joe Gordon
9d4ccbdd35 Move hacking guide to root directory
The hacking guide is in the root directory of every project as
HACKING.rst, except for hacking itself.  Keep the hacking guide as the
index to the docs, but move the file to the root directory.

Change-Id: If128dfc004db2b7427f987ea8a9f643b6c653ce8
2014-01-15 13:53:45 -05:00
Jenkins
abbd89e5ca Merge "checking for metaclass to be Python 3.x compatible" 2014-01-14 19:06:12 +00:00
Joe Gordon
024c3f104f Add H904: don't wrap lines using a backslash
Hacking originally had a soft preference for () versus \ based line
continuation, but this has lead to unnecessary review churn. So in order
to reduce churn be stricter and don't allow \ based line continuation.

Related ML thread
http://lists.openstack.org/pipermail/openstack-dev/2013-November/019024.html

Change-Id: I010623344bc2c4bf86051f86a96afb3611c90342
2014-01-06 12:57:19 -08:00
fujioka yuuichi
bb09c2d32d checking for metaclass to be Python 3.x compatible
The way to using metaclass has changed in Python3.(H236)

Python 2.7 way:

class Foo(object):
  __metaclass__ = FooMeta

Python 3 way:

class Foo(object, metaclass=FooMeta):
  ...

The six.add_metaclass() decorator allows us to use one syntax that
works for both Python 2.7 and Python 3.

Change-Id: I24a00d9e59ffdd9abf4ccf3919737bdb079819eb
Related-Bug: #1236648
2013-12-18 11:33:01 +09:00
Julien Danjou
0ffdb453f3 Add a check for file with only comments
That should catch things like __init__.py files with only license
headers inside.

Change-Id: I6a2078f6264ef252d4eb431c8df33db0913ba3bf
2013-12-09 15:35:33 +01:00
Lei Zhang
d04ad30e09 Fix the escape character
Change-Id: I734926b5af26544d6a8297c80e0c31b9fee9322c
2013-11-12 21:42:29 +08:00
Joe Gordon
9d5ba3861e Remove vim modeline sample
Don't include a vim modeline sample in the import ordering section, as
import ordering is not related to vim modelines.

Change-Id: Ibd25c109967b939a0410ddbc332c17b011b21ab9
2013-11-11 10:52:57 -08:00
Jenkins
b7b477520e Merge "Replace OpenStack LLC with OpenStack Foundation" 2013-10-15 06:02:40 +00:00
Monty Taylor
9c62571b9f Move the hacking guidelines to sphinx docs
Step one in publishing them to an actual place.

Change-Id: I579e7c889f3addc2cd40bce0c584bbc70bf435e2
2013-09-20 16:09:39 -07:00
ZhiQiang Fan
fd16356b90 Replace OpenStack LLC with OpenStack Foundation
Change-Id: I8406a6aa3a0a11c56af1f5f8f2921c0463a55e2b
Fixes-Bug: #1214176
2013-09-20 02:28:38 +08:00
Monty Taylor
4e90f08824 Make hacking a flake8 plugin. 2013-03-18 12:19:25 -07:00