diff --git a/DEVELOPMENT.rst b/DEVELOPMENT.rst index 67ede812..02e637ce 100644 --- a/DEVELOPMENT.rst +++ b/DEVELOPMENT.rst @@ -58,7 +58,7 @@ Binary Extension Many low-level computations have alternate implementations in Fortran. See the `Python Binary Extension`_ page for a more detailed description. -.. _Python Binary Extension: https://bezier.readthedocs.io/en/latest/python/binary-extension.html +.. _Python Binary Extension: https://bezier.readthedocs.io/en/2020.5.19/python/binary-extension.html Building / Compiling ==================== @@ -101,7 +101,7 @@ QUADPACK subroutines depend on). QUADPACK is used to perform numerical quadrature to compute the length of a curve segment. -.. _directory: https://github.com/dhermes/bezier/tree/master/src/fortran/quadpack +.. _directory: https://github.com/dhermes/bezier/tree/2020.5.19/src/fortran/quadpack .. _QUADPACK: https://en.wikipedia.org/wiki/QUADPACK ****************** @@ -261,32 +261,32 @@ To run the functional tests: $ PYTHONPATH=src/python/ python3.8 -m pytest tests/functional/ $ PYTHONPATH=src/python/ pypy3 -m pytest tests/functional/ -.. _functional tests: https://github.com/dhermes/bezier/tree/master/tests/functional +.. _functional tests: https://github.com/dhermes/bezier/tree/2020.5.19/tests/functional For example, the following curve-curve intersection is a functional test case: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/curves11_and_26.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/curves11_and_26.png :align: center and there is a `Curve-Curve Intersection`_ document which captures many of the cases in the functional tests. -.. _Curve-Curve Intersection: https://bezier.readthedocs.io/en/latest/algorithms/curve-curve-intersection.html +.. _Curve-Curve Intersection: https://bezier.readthedocs.io/en/2020.5.19/algorithms/curve-curve-intersection.html A triangle-triangle intersection functional test case: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/triangles1Q_and_2Q.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/triangles1Q_and_2Q.png :align: center a segment-box functional test case: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/test_goes_through_box08.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/test_goes_through_box08.png :align: center and a "locate point on triangle" functional test case: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/test_triangle3_and_point1.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/test_triangle3_and_point1.png :align: center Functional Test Data @@ -304,10 +304,10 @@ This way, the test cases are programming language agnostic and can be repurposed. The `JSON schema`_ for these files are stored in the ``tests/functional/schema`` directory. -.. _curves.json: https://github.com/dhermes/bezier/blob/master/tests/functional/curves.json -.. _curve_intersections.json: https://github.com/dhermes/bezier/blob/master/tests/functional/curve_intersections.json -.. _triangles.json: https://github.com/dhermes/bezier/blob/master/tests/functional/triangles.json -.. _triangle_intersections.json: https://github.com/dhermes/bezier/blob/master/tests/functional/triangle_intersections.json +.. _curves.json: https://github.com/dhermes/bezier/blob/2020.5.19/tests/functional/curves.json +.. _curve_intersections.json: https://github.com/dhermes/bezier/blob/2020.5.19/tests/functional/curve_intersections.json +.. _triangles.json: https://github.com/dhermes/bezier/blob/2020.5.19/tests/functional/triangles.json +.. _triangle_intersections.json: https://github.com/dhermes/bezier/blob/2020.5.19/tests/functional/triangle_intersections.json .. _JSON schema: http://json-schema.org/ ************ @@ -330,7 +330,7 @@ To check compliance: A few extensions and overrides have been specified in the `pylintrc`_ configuration for ``bezier``. -.. _pylintrc: https://github.com/dhermes/bezier/blob/master/pylintrc +.. _pylintrc: https://github.com/dhermes/bezier/blob/2020.5.19/pylintrc Docstring Style =============== @@ -452,11 +452,11 @@ On AppVeyor, the binary extension is built and tested with both 32-bit and .. _CircleCI: https://circleci.com/gh/dhermes/bezier .. _Travis CI: https://travis-ci.org/dhermes/bezier .. _AppVeyor: https://ci.appveyor.com/project/dhermes/bezier -.. _CircleCI config: https://github.com/dhermes/bezier/blob/master/.circleci/config.yml -.. _Travis config: https://github.com/dhermes/bezier/blob/master/.travis.yml -.. _AppVeyor config: https://github.com/dhermes/bezier/blob/master/.appveyor.yml -.. _python-multi Dockerfile: https://github.com/dhermes/python-multi/blob/master/src/Dockerfile -.. _bezier Dockerfile: https://github.com/dhermes/bezier/blob/master/scripts/docker/bezier.Dockerfile +.. _CircleCI config: https://github.com/dhermes/bezier/blob/2020.5.19/.circleci/config.yml +.. _Travis config: https://github.com/dhermes/bezier/blob/2020.5.19/.travis.yml +.. _AppVeyor config: https://github.com/dhermes/bezier/blob/2020.5.19/.appveyor.yml +.. _python-multi Dockerfile: https://github.com/dhermes/python-multi/blob/2020.5.19/src/Dockerfile +.. _bezier Dockerfile: https://github.com/dhermes/bezier/blob/2020.5.19/scripts/docker/bezier.Dockerfile .. _multibuild: https://github.com/matthew-brett/multibuild .. _discontinued: https://github.com/numpy/numpy/issues/11625 @@ -509,7 +509,7 @@ Supported Python Versions Supported versions can be found in the ``noxfile.py`` `config`_. -.. _config: https://github.com/dhermes/bezier/blob/master/noxfile.py +.. _config: https://github.com/dhermes/bezier/blob/2020.5.19/noxfile.py Versioning ========== diff --git a/README.rst b/README.rst index 8ba6bcc9..0cdb8d68 100644 --- a/README.rst +++ b/README.rst @@ -5,8 +5,6 @@ |circle-build| |travis-build| |appveyor-build| |coverage| -|pypi| |versions| - |docs| |zenodo| |JOSS| .. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE @@ -19,7 +17,7 @@ This library provides: Dive in and take a look! -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/triangles6Q_and_7Q.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/triangles6Q_and_7Q.png :align: center Why B |eacute| zier? @@ -28,17 +26,17 @@ Why B |eacute| zier? A B |eacute| zier curve (and triangle, etc.) is a parametric curve that uses the `Bernstein basis`_: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/bernstein_basis.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/bernstein_basis.png :align: center to define a curve as a linear combination: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/bezier_defn.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/bezier_defn.png :align: center This comes from the fact that the weights sum to one: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/sum_to_unity.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/sum_to_unity.png :align: center This can be generalized to higher order by considering three, four, etc. @@ -146,7 +144,7 @@ intersections): >>> _ = ax.set_xlim(-0.125, 1.125) >>> _ = ax.set_ylim(-0.0625, 0.625) -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/curves1_and_13.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/images/curves1_and_13.png :align: center For API-level documentation, check out the B |eacute| zier Python @@ -193,32 +191,26 @@ License ``bezier`` is made available under the Apache 2.0 License. For more details, see `the LICENSE`_. -.. _Curves: https://bezier.readthedocs.io/en/latest/python/reference/bezier.curve.html -.. _Triangles: https://bezier.readthedocs.io/en/latest/python/reference/bezier.triangle.html -.. _package: https://bezier.readthedocs.io/en/latest/python/reference/bezier.html -.. _DEVELOPMENT doc: https://github.com/dhermes/bezier/blob/master/DEVELOPMENT.rst -.. _the LICENSE: https://github.com/dhermes/bezier/blob/master/LICENSE +.. _Curves: https://bezier.readthedocs.io/en/2020.5.19/python/reference/bezier.curve.html +.. _Triangles: https://bezier.readthedocs.io/en/2020.5.19/python/reference/bezier.triangle.html +.. _package: https://bezier.readthedocs.io/en/2020.5.19/python/reference/bezier.html +.. _DEVELOPMENT doc: https://github.com/dhermes/bezier/blob/2020.5.19/DEVELOPMENT.rst +.. _the LICENSE: https://github.com/dhermes/bezier/blob/2020.5.19/LICENSE -.. |docs| image:: https://readthedocs.org/projects/bezier/badge/?version=latest - :target: https://bezier.readthedocs.io/en/latest/ +.. |docs| image:: https://readthedocs.org/projects/bezier/badge/?version=2020.5.19 + :target: https://bezier.readthedocs.io/en/2020.5.19/ :alt: Documentation Status -.. |circle-build| image:: https://img.shields.io/circleci/project/github/dhermes/bezier/master.svg?maxAge=3600&logo=circleci&label=Linux - :target: https://circleci.com/gh/dhermes/bezier +.. |circle-build| image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/circleci-passing.svg?sanitize=true + :target: https://circleci.com/gh/dhermes/bezier/1800 :alt: CircleCI Build -.. |travis-build| image:: https://img.shields.io/travis/dhermes/bezier/master.svg?maxAge=3600&logo=travis&label=macOS - :target: https://travis-ci.org/dhermes/bezier +.. |travis-build| image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/travis-passing.svg?sanitize=true + :target: https://travis-ci.org/dhermes/bezier/builds/689100504 :alt: Travis Build -.. |appveyor-build| image:: https://img.shields.io/appveyor/ci/dhermes/bezier/master.svg?maxAge=3600&logo=appveyor&label=Windows - :target: https://ci.appveyor.com/project/dhermes/bezier +.. |appveyor-build| image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/appveyor-passing.svg?sanitize=true + :target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.1467.master :alt: AppVeyor CI Build -.. |pypi| image:: https://img.shields.io/pypi/v/bezier.svg - :target: https://pypi.org/project/bezier/ - :alt: PyPI Latest -.. |versions| image:: https://img.shields.io/pypi/pyversions/bezier.svg - :target: https://pypi.org/project/bezier/ - :alt: Package Versions -.. |coverage| image:: https://coveralls.io/repos/github/dhermes/bezier/badge.svg - :target: https://coveralls.io/github/dhermes/bezier +.. |coverage| image:: https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_100.svg + :target: https://coveralls.io/builds/30908847 :alt: Code Coverage .. |zenodo| image:: https://zenodo.org/badge/73047402.svg :target: https://zenodo.org/badge/latestdoi/73047402 diff --git a/docs/index.rst b/docs/index.rst index 7e950512..df720fb2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,8 +5,6 @@ |circle-build| |travis-build| |appveyor-build| |coverage| -|pypi| |versions| - |zenodo| |JOSS| .. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE @@ -250,25 +248,19 @@ License ``bezier`` is made available under the Apache 2.0 License. For more details, see `the LICENSE`_. -.. _the LICENSE: https://github.com/dhermes/bezier/blob/master/LICENSE +.. _the LICENSE: https://github.com/dhermes/bezier/blob/2020.5.19/LICENSE -.. |circle-build| image:: https://img.shields.io/circleci/project/github/dhermes/bezier/master.svg?maxAge=3600&logo=circleci&label=Linux - :target: https://circleci.com/gh/dhermes/bezier +.. |circle-build| image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/circleci-passing.svg?sanitize=true + :target: https://circleci.com/gh/dhermes/bezier/1800 :alt: CircleCI Build -.. |travis-build| image:: https://img.shields.io/travis/dhermes/bezier/master.svg?maxAge=3600&logo=travis&label=macOS - :target: https://travis-ci.org/dhermes/bezier +.. |travis-build| image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/travis-passing.svg?sanitize=true + :target: https://travis-ci.org/dhermes/bezier/builds/689100504 :alt: Travis Build -.. |appveyor-build| image:: https://img.shields.io/appveyor/ci/dhermes/bezier/master.svg?maxAge=3600&logo=appveyor&label=Windows - :target: https://ci.appveyor.com/project/dhermes/bezier +.. |appveyor-build| image:: https://raw.githubusercontent.com/dhermes/bezier/2020.5.19/docs/appveyor-passing.svg?sanitize=true + :target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.1467.master :alt: AppVeyor CI Build -.. |pypi| image:: https://img.shields.io/pypi/v/bezier.svg - :target: https://pypi.org/project/bezier/ - :alt: PyPI Latest -.. |versions| image:: https://img.shields.io/pypi/pyversions/bezier.svg - :target: https://pypi.org/project/bezier/ - :alt: Package Versions -.. |coverage| image:: https://coveralls.io/repos/github/dhermes/bezier/badge.svg - :target: https://coveralls.io/github/dhermes/bezier +.. |coverage| image:: https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_100.svg + :target: https://coveralls.io/builds/30908847 :alt: Code Coverage .. |zenodo| image:: https://zenodo.org/badge/73047402.svg :target: https://zenodo.org/badge/latestdoi/73047402