fixed docs

CHANGES.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+0.2.1 (2017-02-26)
+------------------
+
+- fixed docs
+
 0.2.0 (2017-02-25)
 ------------------
 

README.rst

@@ -22,7 +22,7 @@ This is a simple extension that is rendered as HTML widgets:
 Example
 -------
 
-`All in one Example <http://sphinxcontrib-contentui.readthedocs.io/en/latest/example-all.html>`_
+`All-in-One Example <http://sphinxcontrib-contentui.readthedocs.io/en/latest/example-all.html>`_
 
 
 Installation

docs/about.rst

@@ -1,7 +1,7 @@
 About
 =====
 
-This is a simple sphinx extension that is rendered as HTML widgets:
+This is a simple Sphinx extension that is rendered as HTML widgets:
 
 - :ref:`content-tabs`
 - :ref:`column-content`

docs/example-all.rst

@@ -1,6 +1,6 @@
 .. _example-all:
 
-All in one Example
+All-in-One Example
 ------------------
 
 .. container:: left-col
@@ -54,14 +54,14 @@ All in one Example
 
         .. code-block:: python
 
-            my-api.signin()
+            my_api.signin()
 
         .. rubric:: Example request
 
         .. code-block:: python
 
-            import my-api
-            my-api.signin('username', 'password')
+            import my_api
+            my_api.signin('username', 'password')
 
     .. tab-container:: php
         :title: PHP
@@ -76,7 +76,7 @@ All in one Example
 
         .. code-block:: php
 
-            include 'my-api';
+            include 'my-api.php';
             MyApi::signin('username', 'password');
 
 Additional

docs/tabs.rst

@@ -9,16 +9,21 @@ or:
 
 .. rst:directive:: .. container:: content-tabs class
 
-Creates block with content tabs. The same attribute `class` in several
-blocks allows you to synchronize switching tabs.
+"content-tabs" directive creates a block with content tabs.
+Content of only one tab will be shown at the same time.
+Content switches with click on corresponding tab's caption.
+Click on caption of `tab-container`'s caption with the same `name` attribute
+activates all tabs with the same `name` in all `content-tab` blocks with the same
+attribute `class`.
 
-If you specify a class of :ref:`right-col <column-content>` then the menu
-will be fixed in the upper right position, see :ref:`example-all`.
+Special class :ref:`right-col <column-content>` fixates the "content-tabs"
+menu in the upper right position, see :ref:`example-all`.
 
 .. rst:directive:: .. tab-container:: name
 
-Creates content tab. Tab caption set in `title` option. The name attribute
-must match the name tab of another block if you want to synchronize them.
+"tab-container" directive creates a content tab. Tab's caption is set by
+`title` option. To switch tabs synchronously the `name` attribute should match
+with "tab-container" from another blocks.
 
 Full example::
 
@@ -35,7 +40,7 @@ Full example::
             Content for tab two
 
 
-It's render this:
+will be rendered like this:
 
 .. content-tabs::
 
@@ -78,14 +83,14 @@ More examples
 
         .. code-block:: python
 
-            my-api.signin()
+            my_api.signin()
 
         .. rubric:: Example request
 
         .. code-block:: python
 
-            import my-api
-            my-api.signin('username', 'password')
+            import my_api
+            my_api.signin('username', 'password')
 
 
     .. tab-container:: php
@@ -101,5 +106,5 @@ More examples
 
         .. code-block:: php
 
-            include 'my-api';
+            include 'my-api.php';
             MyApi::signin('username', 'password');

docs/toggle.rst

@@ -5,9 +5,10 @@ Toggle headers
 
 .. rst:directive:: .. toggle-header:: class
 
-Creates a header with toggled content. Optional attribute `class` adding
-css class for header paragraph. Required option `header` set text of
-header.
+"toggle-header" directive creates a block with a visible heading for the
+hidden content. The heading can be clicked to view/hide the hidden content.
+Optional attribute `class` adds css class for hidden content.
+Required option `header` sets text of the heading of the hidden content.
 
 Full example::
 
@@ -17,7 +18,7 @@ Full example::
             Content for header
 
 
-It's render this:
+will be rendered like this:
 
 .. toggle-header::
     :header: Example 1 **Show/Hide Code**

setup.py

@@ -10,7 +10,7 @@
 
 setup(
     name='sphinxcontrib-contentui',
-    version='0.2.0',
+    version='0.2.1',
     url='https://github.com/ulrobix/sphinxcontrib-contentui',
     download_url='http://pypi.python.org/pypi/sphinxcontrib-contentui',
     license='BSD',