From 3d4dc4d678596d031799a38951991a30d2fcfea3 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Tue, 23 Jan 2018 10:17:36 -0800 Subject: [PATCH] [ci skip] Updated README / docs for release 0.6.2. --- DEVELOPMENT.rst | 34 +++++++++++++-------------- README.rst | 48 ++++++++++++++++----------------------- docs/index.rst | 26 ++++++++------------- docs/native-libraries.rst | 6 ++--- 4 files changed, 49 insertions(+), 65 deletions(-) diff --git a/DEVELOPMENT.rst b/DEVELOPMENT.rst index 1bc7d113..1cdcf2e9 100644 --- a/DEVELOPMENT.rst +++ b/DEVELOPMENT.rst @@ -33,7 +33,7 @@ Many low-level computations have alternate implementations in Fortran. See the `Native Libraries`_ page in the documentation for a more detailed description. -.. _Native Libraries: https://bezier.readthedocs.io/en/latest/native-libraries.html +.. _Native Libraries: https://bezier.readthedocs.io/en/0.6.2/native-libraries.html Building / Compiling ==================== @@ -258,32 +258,32 @@ To run the functional tests: $ PYTHONPATH=src/ python3.6 -m pytest tests/functional/ $ PYTHONPATH=src/ pypy -m pytest tests/functional/ -.. _functional tests: https://github.com/dhermes/bezier/tree/master/tests/functional +.. _functional tests: https://github.com/dhermes/bezier/tree/0.6.2/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/0.6.2/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/curve-curve-intersection.html +.. _Curve-Curve Intersection: https://bezier.readthedocs.io/en/0.6.2/curve-curve-intersection.html A surface-surface intersection functional test case: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/surfaces1Q_and_2Q.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/0.6.2/docs/images/surfaces1Q_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/0.6.2/docs/images/test_goes_through_box08.png :align: center and a "locate point on surface" functional test case: -.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/test_surface3_and_point1.png +.. image:: https://raw.githubusercontent.com/dhermes/bezier/0.6.2/docs/images/test_surface3_and_point1.png :align: center Functional Test Data @@ -301,10 +301,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 -.. _surfaces.json: https://github.com/dhermes/bezier/blob/master/tests/functional/surfaces.json -.. _surface_intersections.json: https://github.com/dhermes/bezier/blob/master/tests/functional/surface_intersections.json +.. _curves.json: https://github.com/dhermes/bezier/blob/0.6.2/tests/functional/curves.json +.. _curve_intersections.json: https://github.com/dhermes/bezier/blob/0.6.2/tests/functional/curve_intersections.json +.. _surfaces.json: https://github.com/dhermes/bezier/blob/0.6.2/tests/functional/surfaces.json +.. _surface_intersections.json: https://github.com/dhermes/bezier/blob/0.6.2/tests/functional/surface_intersections.json .. _JSON schema: http://json-schema.org/ ************ @@ -327,7 +327,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/0.6.2/pylintrc Docstring Style =============== @@ -449,11 +449,11 @@ Python binaries. .. _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 +.. _CircleCI config: https://github.com/dhermes/bezier/blob/0.6.2/.circleci/config.yml +.. _Travis config: https://github.com/dhermes/bezier/blob/0.6.2/.travis.yml +.. _AppVeyor config: https://github.com/dhermes/bezier/blob/0.6.2/.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 +.. _bezier Dockerfile: https://github.com/dhermes/bezier/blob/0.6.2/scripts/docker/bezier.Dockerfile .. _multibuild: https://github.com/matthew-brett/multibuild **************************************** @@ -503,7 +503,7 @@ Supported Python Versions Supported versions can be found in the ``nox.py`` `config`_. -.. _config: https://github.com/dhermes/bezier/blob/master/nox.py +.. _config: https://github.com/dhermes/bezier/blob/0.6.2/nox.py Versioning ========== diff --git a/README.rst b/README.rst index 66566981..4eb3fc65 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://cdn.rawgit.com/dhermes/bezier/master/docs/images/surfaces6Q_and_7Q.png +.. image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/images/surfaces6Q_and_7Q.png :align: center Why B |eacute| zier? @@ -28,17 +26,17 @@ Why B |eacute| zier? A B |eacute| zier curve (and surface, etc.) is a parametric curve that uses the `Bernstein basis`_: -.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/bernstein_basis.png +.. image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/images/bernstein_basis.png :align: center to define a curve as a linear combination: -.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/bezier_defn.png +.. image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/images/bezier_defn.png :align: center This comes from the fact that the weights sum to one: -.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/sum_to_unity.png +.. image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/images/sum_to_unity.png :align: center This can be generalized to higher order by considering three, four, etc. @@ -148,7 +146,7 @@ intersections): >>> _ = ax.set_ylim(-0.0625, 0.625) >>> plt.show() -.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/curves1_and_13.png +.. image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/images/curves1_and_13.png :align: center For API-level documentation, check out the B |eacute| zier @@ -167,32 +165,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/reference/bezier.curve.html -.. _Surfaces: https://bezier.readthedocs.io/en/latest/reference/bezier.surface.html -.. _Package: https://bezier.readthedocs.io/en/latest/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/0.6.2/reference/bezier.curve.html +.. _Surfaces: https://bezier.readthedocs.io/en/0.6.2/reference/bezier.surface.html +.. _Package: https://bezier.readthedocs.io/en/0.6.2/reference/bezier.html +.. _DEVELOPMENT doc: https://github.com/dhermes/bezier/blob/0.6.2/DEVELOPMENT.rst +.. _the LICENSE: https://github.com/dhermes/bezier/blob/0.6.2/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=0.6.2 + :target: https://bezier.readthedocs.io/en/0.6.2/ :alt: Documentation Status -.. |circle-build| image:: https://img.shields.io/circleci/project/github/dhermes/bezier/master.svg?maxAge=3600&label=Linux - :target: https://circleci.com/gh/dhermes/bezier +.. |circle-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/circleci-passing.svg + :target: https://circleci.com/gh/dhermes/bezier/1165 :alt: CircleCI Build -.. |travis-build| image:: https://img.shields.io/travis/dhermes/bezier/master.svg?maxAge=3600&label=Mac%20OS%20X - :target: https://travis-ci.org/dhermes/bezier +.. |travis-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/travis-passing.svg + :target: https://travis-ci.org/dhermes/bezier/builds/332420781 :alt: Travis Build -.. |appveyor-build| image:: https://img.shields.io/appveyor/ci/dhermes/bezier/master.svg?maxAge=3600&label=Windows - :target: https://ci.appveyor.com/project/dhermes/bezier +.. |appveyor-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/appveyor-passing.svg + :target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.838.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/15183214 :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 b7e27818..772bc874 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 @@ -225,25 +223,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/0.6.2/LICENSE -.. |circle-build| image:: https://img.shields.io/circleci/project/github/dhermes/bezier/master.svg?maxAge=3600&label=Linux - :target: https://circleci.com/gh/dhermes/bezier +.. |circle-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/circleci-passing.svg + :target: https://circleci.com/gh/dhermes/bezier/1165 :alt: CircleCI Build -.. |travis-build| image:: https://img.shields.io/travis/dhermes/bezier/master.svg?maxAge=3600&label=Mac%20OS%20X - :target: https://travis-ci.org/dhermes/bezier +.. |travis-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/travis-passing.svg + :target: https://travis-ci.org/dhermes/bezier/builds/332420781 :alt: Travis Build -.. |appveyor-build| image:: https://img.shields.io/appveyor/ci/dhermes/bezier/master.svg?maxAge=3600&label=Windows - :target: https://ci.appveyor.com/project/dhermes/bezier +.. |appveyor-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.6.2/docs/appveyor-passing.svg + :target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.838.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/15183214 :alt: Code Coverage .. |zenodo| image:: https://zenodo.org/badge/73047402.svg :target: https://zenodo.org/badge/latestdoi/73047402 diff --git a/docs/native-libraries.rst b/docs/native-libraries.rst index 5be9d48e..6b8a26d1 100644 --- a/docs/native-libraries.rst +++ b/docs/native-libraries.rst @@ -617,9 +617,9 @@ For examples, see: * `Mac OS X journal`_ * `Windows journal`_ -.. _Linux journal: https://github.com/dhermes/bezier/blob/master/.circleci/expected_journal.txt -.. _Mac OS X journal: https://github.com/dhermes/bezier/blob/master/scripts/osx/travis_journal.txt -.. _Windows journal: https://github.com/dhermes/bezier/blob/master/appveyor/expected_journal.txt +.. _Linux journal: https://github.com/dhermes/bezier/blob/0.6.2/.circleci/expected_journal.txt +.. _Mac OS X journal: https://github.com/dhermes/bezier/blob/0.6.2/scripts/osx/travis_journal.txt +.. _Windows journal: https://github.com/dhermes/bezier/blob/0.6.2/appveyor/expected_journal.txt *************************** Building a Python Extension