Skip to content

Commit

Permalink
Address feedback
Browse files Browse the repository at this point in the history
- Move Folder import to top (and sort imports)
- Bump setuptools
- Inline readme
- Adjust copyright and description in conf.py
  • Loading branch information
jamadden committed Dec 15, 2016
1 parent 6105a53 commit b7a17bd
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
pip>=9.0.0
sphinx>=1.4
setuptools>=23.0.0
setuptools>=31.0.1
repoze.sphinx.autointerface
sphinx_rtd_theme
9 changes: 6 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

# General information about the project.
project = 'zope.container'
copyright = '2015, Zope Foundation and Contributors'
copyright = '2016, Zope Foundation and Contributors'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -249,7 +249,8 @@
# dir menu entry, description, category)
texinfo_documents = [
('index', 'zopecontainer', 'zope.container Documentation',
'Zope Foundation and Contributors', 'zopecontainer', 'One line description of project.',
'Zope Foundation and Contributors', 'zopecontainer',
'Interfaces for object container components, and implementations such as a BTreeContainer and OrderedContainer',
'Miscellaneous'),
]

Expand All @@ -270,9 +271,11 @@
intersphinx_mapping = {
'https://docs.python.org/': None,
'http://zodb.readthedocs.io/en/latest/': None,
'http://relstorage.readthedocs.io/en/latest/': None,
'http://persistent.readthedocs.io/en/latest/': None,
'http://zopesize.readthedocs.io/en/latest/': None,
'http://zopesite.readthedocs.io/en/latest/': None,
'http://zopefilerepresentation.readthedocs.io/en/latest/': None,
'http://zopelifecycleevent.readthedocs.io/en/latest/': None,
}

extlinks = {'issue': ('https://github.com/zopefoundation/zope.container/issues/%s',
Expand Down
17 changes: 16 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
.. include:: ../README.rst
================
zope.container
================

.. image:: https://travis-ci.org/zopefoundation/zope.container.png?branch=master
:target: https://travis-ci.org/zopefoundation/zope.container

.. image:: https://readthedocs.org/projects/zopecontainer/badge/?version=latest
:target: http://zopecontainer.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

This package define interfaces of container components, and provides
container implementations such as a :class:`~.BTreeContainer` and
:class:`~.OrderedContainer`, as well as the base class used by :mod:`zope.site.folder`
for the :class:`~.Folder` implementation.


Contents:

Expand Down
8 changes: 6 additions & 2 deletions src/zope/container/directory.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@
from zope.interface import implementer

from zope.component.interfaces import ISite
from zope.container.folder import Folder
from zope.security.proxy import removeSecurityProxy
import zope.filerepresentation.interfaces

from six.moves import map


Expand All @@ -44,7 +46,10 @@ def noop(container):

@implementer(zope.filerepresentation.interfaces.IDirectoryFactory)
class Cloner(object):
"""`IContainer` to `IDirectoryFactory` adapter that clones
"""
`IContainer` to
:class:`zope.filerepresentation.interfaces.IDirectoryFactory` adapter
that clones.
This adapter provides a factory that creates a new empty container
of the same class as it's context.
Expand All @@ -70,7 +75,6 @@ def __init__(self, context):
pass

def __call__(self, name):
from zope.container.folder import Folder
return Folder()


Expand Down

0 comments on commit b7a17bd

Please sign in to comment.