Skip to content

Commit

Permalink
doc: move the table to show supported formats by plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
ssato committed Jan 14, 2018
1 parent d7d68a3 commit fc63538
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 25 deletions.
26 changes: 13 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ and backends in charge are enabled and ready to use:

- Always supported formats of which backends are enabled by default:

.. csv-table::
.. csv-table:: Always supported formats
:header: "Format", "Type", "Requirement"
:widths: 15, 10, 40

Expand All @@ -250,7 +250,7 @@ and backends in charge are enabled and ready to use:

- Supported formats of which backends are enabled automatically if requirements are satisfied:

.. csv-table::
.. csv-table:: Supported formarts if requirements are satisfied
:header: "Format", "Type", "Requirement"
:widths: 15, 10, 40

Expand All @@ -260,6 +260,15 @@ and backends in charge are enabled and ready to use:
TOML, toml, ``toml`` [#]_
BSON, bson, bson in ``pymongo`` [#]_

- Supported formats of which backends are enabled automatically if required pluggable modules are installed: python-anyconfig utilizes plugin mechanism provided by setuptools [#]_ and may support other formats if corresponding pluggable backend modules:

.. csv-table:: Supported formats by pluggable backend modules
:header: "Format", "Type", "Pluggable backend"
:widths: 15, 10, 40

Amazon Ion, ion, ``anyconfig-ion-backend`` [#]_
CBOR, cbor, ``anyconfig-cbor-backend`` [#]_ or ``anyconfig-cbor2-backend`` [#]_

The supported formats of python-anyconfig on your system are able to be listed
by 'anyconfig_cli -L' like this:

Expand All @@ -278,16 +287,6 @@ or with the API 'anyconfig.list_types()' will show them:
In [9]:
python-anyconfig utilizes plugin mechanism provided by setuptools [#]_ and
other formats may be supported if corresponding pluggable backend modules like
the followings are installed:

.. csv-table:: Supported formats by pluggable backend modules
:header: "Format", "Type", "Pluggable backend"
:widths: 15, 10, 40

CBOR, cbor, ``anyconfig-cbor-backend`` [#]_

.. [#] https://pypi.python.org/pypi/simplejson
.. [#] ex. https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html
.. [#] https://pypi.python.org/pypi/ruamel.yaml
Expand All @@ -296,9 +295,10 @@ the followings are installed:
.. [#] https://pypi.python.org/pypi/msgpack-python
.. [#] https://pypi.python.org/pypi/toml
.. [#] https://pypi.python.org/pypi/pymongo
.. [#] https://pypi.python.org/pypi/cbor
.. [#] http://peak.telecommunity.com/DevCenter/setuptools#dynamic-discovery-of-services-and-plugins
.. [#] https://pypi.python.org/pypi/anyconfig-ion-backend
.. [#] https://pypi.python.org/pypi/anyconfig-cbor-backend
.. [#] https://pypi.python.org/pypi/anyconfig-cbor2-backend
Installation
-------------
Expand Down
25 changes: 13 additions & 12 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ and backends in charge are enabled and ready to use:

- Always supported formats of which backends are enabled by default:

.. csv-table::
.. csv-table:: Always supported formats
:header: "Format", "Type", "Requirement"
:widths: 15, 10, 40

Expand All @@ -205,7 +205,7 @@ and backends in charge are enabled and ready to use:

- Supported formats of which backends are enabled automatically if requirements are satisfied:

.. csv-table::
.. csv-table:: Supported formarts if requirements are satisfied
:header: "Format", "Type", "Requirement"
:widths: 15, 10, 40

Expand All @@ -215,6 +215,15 @@ and backends in charge are enabled and ready to use:
TOML, toml, ``toml`` [#]_
BSON, bson, bson in ``pymongo`` [#]_

- Supported formats of which backends are enabled automatically if required pluggable modules are installed: python-anyconfig utilizes plugin mechanism provided by setuptools [#]_ and may support other formats if corresponding pluggable backend modules:

.. csv-table:: Supported formats by pluggable backend modules
:header: "Format", "Type", "Pluggable backend"
:widths: 15, 10, 40

Amazon Ion, ion, ``anyconfig-ion-backend`` [#]_
CBOR, cbor, ``anyconfig-cbor-backend`` [#]_ or ``anyconfig-cbor2-backend`` [#]_

The supported formats of python-anyconfig on your system are able to be listed
by 'anyconfig_cli -L' like this:

Expand All @@ -233,16 +242,6 @@ or with the API 'anyconfig.list_types()' will show them:
In [9]:
python-anyconfig utilizes plugin mechanism provided by setuptools [#]_ and may
support other formats if corresponding pluggable backend modules like the
followings are installed:

.. csv-table:: Supported formats by pluggable backend modules
:header: "Format", "Type", "Pluggable backend"
:widths: 15, 10, 40

CBOR, cbor, ``anyconfig-cbor-backend`` [#]_

.. [#] https://pypi.python.org/pypi/simplejson
.. [#] ex. https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html
.. [#] https://pypi.python.org/pypi/ruamel.yaml
Expand All @@ -252,7 +251,9 @@ followings are installed:
.. [#] https://pypi.python.org/pypi/toml
.. [#] https://pypi.python.org/pypi/pymongo
.. [#] http://peak.telecommunity.com/DevCenter/setuptools#dynamic-discovery-of-services-and-plugins
.. [#] https://pypi.python.org/pypi/anyconfig-ion-backend
.. [#] https://pypi.python.org/pypi/anyconfig-cbor-backend
.. [#] https://pypi.python.org/pypi/anyconfig-cbor2-backend
Installation
-------------
Expand Down

0 comments on commit fc63538

Please sign in to comment.