Update docs files

Author: humitos

CHANGELOG.rst

@@ -1,3 +1,23 @@
+1.0.0
+-----
+
+:Date: UNRELEASED
+
+  * Remove ability to add the warning banner statically
+
+  * Make the banner more customizable (all the configs are included in the ``json`` file generated and available from Javascript)
+
+  * Rename ``versionwarning_default_admonition_type`` by ``versionwarning_admonition_type``
+
+  * Rename ``versionwarning_body_default_selector`` by ``versionwarning_body_selector``
+
+  * Remove ``versionwarning_body_extra_selector``
+
+  * Refactor the code to avoid potential circular imports
+
+  * Filter Read the Docs versions by ``active=True`` when retrieving versions
+
+
 0.2.0
 -----
 

README.rst

@@ -18,9 +18,9 @@ How it works?
 -------------
 
 When visiting a page in Read the Docs that was built with this extension enabled,
-an AJAX request is done to the Read the Docs servers to retrieve all the versions of the project.
+an AJAX request is done to the Read the Docs servers to retrieve all the **active versions** of the project.
 These versions are compared against the one that we are reading and if it's an old version,
-a red *Warning* banner appears at the top of the page.
+a *Warning* banner appears at the top of the page.
 
 
 Examples
@@ -31,13 +31,11 @@ Examples
 There is a live example living at Read the Docs:
 
 - `latest`_ version doesn't show any kind of warning banner
-- `0.0.1`_ version shows a custom and fixed message added at build time
 - `0.0.2`_ version shows a warning banner saying that 0.0.3 is available (at the time of writing this docs)
 - `0.0.3`_ version doesn't show any banner since it's the latest version (at the time of writing this docs)
 
 
 .. _latest: https://sphinx-version-warning-example.readthedocs.io/en/latest/
-.. _0.0.1: https://sphinx-version-warning-example.readthedocs.io/en/0.0.1/
 .. _0.0.2: https://sphinx-version-warning-example.readthedocs.io/en/0.0.2/
 .. _0.0.3: https://sphinx-version-warning-example.readthedocs.io/en/0.0.3/
 
@@ -57,14 +55,16 @@ Then in your ``conf.py`` you have to add ``versionwarning`` in the ``extensions`
   ]
 
 
-Remember to configure the ``version`` of your Sphinx project since it's the key for this to work properly::
+Remember to configure the ``versionwarning_project_version`` and ``versionwarning_project_slug`` of your Sphinx project since it's the key for this to work properly::
 
-  version = '0.0.1'
+  versionwarning_project_version = '0.0.1'
+  versionwarning_project_slug = 'sphinx-version-warning'
 
 .. warning::
 
-   If ``READTHEDOCS_VERSION`` variable is defined, the extension will use its value.
-   Otherwise, ``versionwarning_project_version`` will be used and if it's not defined, ``version`` as last resource.
+   If you are building your documentation under Read the Docs,
+   ``READTHEDOCS_VERSION`` and ``READTHEDOCS_PROECT`` environment variables will be defined and there is no need to define these variables,
+   unless you want to override the default values.
 
 
 Customization
@@ -81,11 +81,14 @@ versionwarning_default_message (string)
 versionwarning_messages (dict)
    mapping between versions and messages for its banners
 
+versionwarning_message_placeholder (string)
+   text to be replaced by the version number link from the message
+
 versionwarning_project_slug (string)
    slug of the project under Read the Docs (default to ``READTHEDOCS_PROJECT`` environment variable)
 
 versionwarning_project_version (string)
-   slug of the version for the current documentation (default to ``READTHEDOCS_VERSION`` environment variable or ``version`` variable from ``conf.py``)
+   slug of the version for the current documentation (default to ``READTHEDOCS_VERSION`` environment variable)
 
 versionwarning_api_url (string)
    API URL to retrieve all versions for this project