Update documentation (#74)

Co-authored-by: Adam Turner <[email protected]>

Author: rffontenelle

CHANGES.rst

@@ -7,18 +7,22 @@ CHANGES
 
 Environments
 ------------
+- #71: Drop Python 3.5 support
+- #72: Declare support for Python 3.11 and Python 3.12
 
 Incompatibility
 ---------------
 
 Features
 --------
+- #62: Migrate from transifex-client to transifex cli
 
 Documentation
 -------------
 
 Bug Fixes
 ---------
+- #53: Set locale of created po files
 - #55: FileNotFoundError on update-txconfig-resources in the subdirectory
 
 2.0.1 (2020/04/11)

README.rst

@@ -23,9 +23,9 @@ Optional: support the Transifex service for translation with Sphinx_ .
    :alt: License
    :target: https://github.com/sphinx-doc/sphinx-intl/blob/master/LICENSE
 
-.. image:: https://img.shields.io/travis/sphinx-doc/sphinx-intl/master.svg
-   :alt: Travis (.org) branch
-   :target: https://travis-ci.org/sphinx-doc/sphinx-intl
+.. image:: https://github.com/sphinx-doc/sphinx-intl/actions/workflows/test.yml/badge.svg?branch=master
+   :alt: GitHub Actions CI status
+   :target: https://github.com/sphinx-doc/sphinx-intl/actions/workflows/test.yml
 
 .. image:: https://img.shields.io/github/stars/sphinx-doc/sphinx-intl.svg?style=social&label=Stars
    :alt: GitHub stars
@@ -45,4 +45,4 @@ Licensed under the BSD license.
 CHANGES
 =======
 
-See: https://sphinx-intl.readthedocs.io/en/master/changes.html
+See: https://sphinx-intl.readthedocs.io/en/master/changes.html

checklist.rst

@@ -2,7 +2,7 @@
 
 Procedure:
 
-1. check travis-ci testing result: https://travis-ci.org/sphinx-doc/sphinx-intl
+1. check GitHub Actions test results: https://github.com/sphinx-doc/sphinx-intl/actions
 2. update release version/date in ``CHANGES.rst``
 3. ``python setup.py release sdist bdist_egg``
 4. ``twine upload dist/<target-package-file>``

doc/basic.rst

@@ -13,7 +13,7 @@ Basic Features
 
 Optional features
 ==================
-These features depends to `transifex-client`_ library.
+These features depends on the `transifex-client`_ tool.
 Please refer Installation_ section to install it.
 
 * create ``.transifexrc`` file from environment variable, without interactive
@@ -27,17 +27,16 @@ You need to use `tx` command for below features:
 * ``tx push -s`` : push pot (translation catalogs) to transifex.
 * ``tx pull -l ja`` : pull po (translated catalogs) from transifex.
 
-.. _transifex-client: https://pypi.python.org/pypi/transifex-client
+.. _transifex-client: https://github.com/transifex/cli
 
 
 Installation
 =============
 
-Recommend strongly: use virtualenv/venv for this procedure::
+It is strongly recommended to use virtualenv/venv for this procedure::
 
    $ pip install sphinx-intl
 
-If you want to use `Optional Features`_, you need install additional library::
-
-   $ pip install sphinx-intl[transifex]
+If you want to use `Optional Features`_, you need install Transifex CLI tool.
+Please refer to `Installation instructions <https://github.com/transifex/cli#installation>`.
 

doc/dev.rst

@@ -16,20 +16,23 @@ Setup development environment
 =============================
 
 * Requires supported Python version
-* do setup under sphinx-intl.git repository root as::
+* Do setup under sphinx-intl.git repository root as::
 
     $ pip install -U pip setuptools wheel setuptools_scm
     $ pip install -r requirements-testing.txt
 
+* Install Transifex CLI tool (refer to `Installation instructions <https://github.com/transifex/cli#installation>`_)::
+
+    $ curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
+
 Testing
 =======
 
 Tests with supported python version that are in:
 
 * ``setup.py``
 * ``tox.ini``
-* ``.travis.yml``
-
+* ``.github/workflow/test.yml``
 
 Run test
 --------
@@ -43,9 +46,9 @@ tox have several sections for testing.
 CI (Continuous Integration)
 ----------------------------
 
-All tests will be run on Travis CI service.
+All tests will be run on GitHub Actions.
 
-* https://travis-ci.org/sphinx-doc/sphinx-intl
+* https://github.com/sphinx-doc/sphinx-intl/tree/master/.github/workflows/
 
 Releasing
 =========
@@ -55,7 +58,7 @@ New package version
 
 The sphinx-intl package will be uploaded to PyPI: https://pypi.org/project/sphinx-intl/.
 
-Here is a release procefure for releasing.
+Here is a release procedure:
 
 .. include:: ../checklist.rst
 

doc/index.rst

@@ -23,9 +23,9 @@ Optional: support the Transifex service for translation with Sphinx_ .
    :alt: License
    :target: https://github.com/sphinx-doc/sphinx-intl/blob/master/LICENSE
 
-.. image:: https://img.shields.io/travis/sphinx-doc/sphinx-intl/master.svg
-   :alt: Travis (.org) branch
-   :target: https://travis-ci.org/sphinx-doc/sphinx-intl
+.. image:: https://github.com/sphinx-doc/sphinx-intl/actions/workflows/test.yml/badge.svg?branch=master
+   :alt: GitHub Actions CI status
+   :target: https://github.com/sphinx-doc/sphinx-intl/actions/workflows/test.yml
 
 .. image:: https://img.shields.io/github/stars/sphinx-doc/sphinx-intl.svg?style=social&label=Stars
    :alt: GitHub stars