From 5f9893f1207380754a85be51e86652bc6d2b8ecc Mon Sep 17 00:00:00 2001 From: Liuyang Wan <tsfdye@gmail.com> Date: Mon, 23 Nov 2020 22:25:52 +0800 Subject: [PATCH 1/3] Add docs/requirements.txt --- docs/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..c5e7e301 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx==3.2.1 +sphinx_bootstrap_theme==0.7.1 From 18ecc5a199c324b344bfc2f99f9456f806acde41 Mon Sep 17 00:00:00 2001 From: Liuyang Wan <tsfdye@gmail.com> Date: Mon, 23 Nov 2020 22:36:39 +0800 Subject: [PATCH 2/3] Use same docs requirements in tox --- tox.ini | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 1ca3286b..bc3300ab 100644 --- a/tox.ini +++ b/tox.ini @@ -12,6 +12,5 @@ commands = pytest {posargs} [testenv:docs] deps = - sphinx - sphinx_bootstrap_theme + -rdocs/requirements.txt commands = sphinx-build docs build From 3f40bd75d6cc3efee1e72413bc685e7bbf9b5a46 Mon Sep 17 00:00:00 2001 From: Liuyang Wan <tsfdye@gmail.com> Date: Mon, 23 Nov 2020 22:50:38 +0800 Subject: [PATCH 3/3] Add docs build status badge to README.md --- README.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 5c090804..1ab43e53 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,12 @@ Overview: Easy, clean, reliable Python 2/3 compatibility ======================================================== +.. image:: https://travis-ci.org/PythonCharmers/python-future.svg?branch=master + :target: https://travis-ci.org/PythonCharmers/python-future + +.. image:: https://readthedocs.org/projects/python-future/badge/?version=latest + :target: https://python-future.readthedocs.io/en/latest/?badge=latest + ``python-future`` is the missing compatibility layer between Python 2 and Python 3. It allows you to use a single, clean Python 3.x-compatible codebase to support both Python 2 and Python 3 with minimal overhead. @@ -22,9 +28,6 @@ are `Mezzanine <http://mezzanine.jupo.org/>`_ and `ObsPy Features -------- -.. image:: https://travis-ci.org/PythonCharmers/python-future.svg?branch=master - :target: https://travis-ci.org/PythonCharmers/python-future - - ``future.builtins`` package (also available as ``builtins`` on Py2) provides backports and remappings for 20 builtins with different semantics on Py3 versus Py2