-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #71 from NextThought/issue64
Docs
- Loading branch information
Showing
65 changed files
with
2,216 additions
and
554 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
======================== | ||
Advanced Customization | ||
======================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
extension_points | ||
proxy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
======== | ||
Basics | ||
======== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
interfaces | ||
externalization | ||
internalization | ||
datastructures | ||
zcml | ||
autopackage | ||
|
||
``nti.externalization`` | ||
======================= | ||
|
||
.. module:: nti.externalization | ||
|
||
The ``nti.externalization`` module has the top-level APIs. | ||
|
||
.. autofunction:: nti.externalization.to_external_object | ||
.. autofunction:: nti.externalization.to_external_representation | ||
.. autofunction:: nti.externalization.new_from_external_object | ||
.. autofunction:: nti.externalization.update_from_external_object |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
========= | ||
Helpers | ||
========= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
factory | ||
datetime | ||
dublincore | ||
singleton |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
========= | ||
Strings | ||
========= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
integer_strings | ||
representation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
================== | ||
ZODB Integration | ||
================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: ZODB Integration | ||
|
||
oids | ||
persistence |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
============ | ||
Package IO | ||
============ | ||
|
||
.. automodule:: nti.externalization.autopackage | ||
:private-members: | ||
:special-members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
================ | ||
Datastructures | ||
================ | ||
|
||
.. automodule:: nti.externalization.datastructures | ||
:private-members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
========== | ||
Datetime | ||
========== | ||
|
||
.. automodule:: nti.externalization.datetime |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
============ | ||
Dublincore | ||
============ | ||
|
||
.. automodule:: nti.externalization.dublincore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
================================================================== | ||
``nti.externalization.extension_points``: Pluggable integrations | ||
================================================================== | ||
|
||
.. automodule:: nti.externalization.extension_points | ||
|
||
.. | ||
Things decorated with @hookable have to be manually listed, | ||
even when they are in __all__ | ||
.. autofunction:: nti.externalization.extension_points.get_current_request | ||
.. autofunction:: nti.externalization.extension_points.set_external_identifiers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
================= | ||
Externalization | ||
================= | ||
|
||
.. automodule:: nti.externalization.externalization |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
=================================================== | ||
``nti.externalization.factory``: Object factories | ||
=================================================== | ||
|
||
.. automodule:: nti.externalization.factory |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
============= | ||
API Details | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
BASICS | ||
STRINGS | ||
ADVANCED | ||
ZODB | ||
HELPERS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
===================================================================================== | ||
``nti.externalization.integer_strings``: Short readable strings from large integers | ||
===================================================================================== | ||
|
||
.. automodule:: nti.externalization.integer_strings |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
============================================================== | ||
``nti.externalization.interfaces``: Interfaces and constants | ||
============================================================== | ||
|
||
.. autoclass:: nti.externalization._base_interfaces.LocatedExternalDict | ||
.. autoclass:: nti.externalization._base_interfaces.StandardExternalFields | ||
.. autoclass:: nti.externalization._base_interfaces.StandardInternalFields | ||
.. automodule:: nti.externalization.interfaces |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
================= | ||
Internalization | ||
================= | ||
|
||
.. automodule:: nti.externalization.internalization |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
========================================================= | ||
``nti.externalization.oids``: Stable object identifiers | ||
========================================================= | ||
|
||
.. automodule:: nti.externalization.oids |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
================================================================ | ||
``nti.externalization.persistence``: Pickling and ZODB support | ||
================================================================ | ||
|
||
.. automodule:: nti.externalization.persistence |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
================================================================ | ||
``nti.externalization.proxy``: Support for transparent proxies | ||
================================================================ | ||
|
||
.. automodule:: nti.externalization.proxy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
================================================================================ | ||
``nti.externalization.representation``: Reading and writing objects to strings | ||
================================================================================ | ||
|
||
.. automodule:: nti.externalization.representation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
=========== | ||
Singleton | ||
=========== | ||
|
||
.. automodule:: nti.externalization.singleton |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
====== | ||
ZCML | ||
====== | ||
|
||
.. automodule:: nti.externalization.zcml | ||
|
||
.. autofunction:: nti.externalization.internalization.legacy_factories.find_factories_in_module |
Oops, something went wrong.