Skip to content

Commit

Permalink
[ci skip] Updated README / docs for release 0.6.1.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhermes committed Jan 12, 2018
1 parent 02ee12e commit 87a7b8d
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 65 deletions.
34 changes: 17 additions & 17 deletions DEVELOPMENT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.1/native-libraries.html

Building / Compiling
====================
Expand Down Expand Up @@ -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.1/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.1/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.1/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.1/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.1/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.1/docs/images/test_surface3_and_point1.png
:align: center

Functional Test Data
Expand All @@ -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.1/tests/functional/curves.json
.. _curve_intersections.json: https://github.com/dhermes/bezier/blob/0.6.1/tests/functional/curve_intersections.json
.. _surfaces.json: https://github.com/dhermes/bezier/blob/0.6.1/tests/functional/surfaces.json
.. _surface_intersections.json: https://github.com/dhermes/bezier/blob/0.6.1/tests/functional/surface_intersections.json
.. _JSON schema: http://json-schema.org/

************
Expand All @@ -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.1/pylintrc

Docstring Style
===============
Expand Down Expand Up @@ -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.1/.circleci/config.yml
.. _Travis config: https://github.com/dhermes/bezier/blob/0.6.1/.travis.yml
.. _AppVeyor config: https://github.com/dhermes/bezier/blob/0.6.1/.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.1/scripts/docker/bezier.Dockerfile
.. _multibuild: https://github.com/matthew-brett/multibuild

****************************************
Expand Down Expand Up @@ -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.1/nox.py

Versioning
==========
Expand Down
48 changes: 20 additions & 28 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.1/docs/images/surfaces6Q_and_7Q.png
:align: center

Why B |eacute| zier?
Expand All @@ -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.1/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.1/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.1/docs/images/sum_to_unity.png
:align: center

This can be generalized to higher order by considering three, four, etc.
Expand Down Expand Up @@ -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.1/docs/images/curves1_and_13.png
:align: center

For API-level documentation, check out the B |eacute| zier
Expand All @@ -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.1/reference/bezier.curve.html
.. _Surfaces: https://bezier.readthedocs.io/en/0.6.1/reference/bezier.surface.html
.. _Package: https://bezier.readthedocs.io/en/0.6.1/reference/bezier.html
.. _DEVELOPMENT doc: https://github.com/dhermes/bezier/blob/0.6.1/DEVELOPMENT.rst
.. _the LICENSE: https://github.com/dhermes/bezier/blob/0.6.1/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.1
:target: https://bezier.readthedocs.io/en/0.6.1/
: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.1/docs/circleci-passing.svg
:target: https://circleci.com/gh/dhermes/bezier/1155
: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.1/docs/travis-passing.svg
:target: https://travis-ci.org/dhermes/bezier/builds/328265685
: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.1/docs/appveyor-passing.svg
:target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.829.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/15029144
:alt: Code Coverage
.. |zenodo| image:: https://zenodo.org/badge/73047402.svg
:target: https://zenodo.org/badge/latestdoi/73047402
Expand Down
26 changes: 9 additions & 17 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -224,25 +222,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.1/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.1/docs/circleci-passing.svg
:target: https://circleci.com/gh/dhermes/bezier/1155
: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.1/docs/travis-passing.svg
:target: https://travis-ci.org/dhermes/bezier/builds/328265685
: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.1/docs/appveyor-passing.svg
:target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.829.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/15029144
:alt: Code Coverage
.. |zenodo| image:: https://zenodo.org/badge/73047402.svg
:target: https://zenodo.org/badge/latestdoi/73047402
Expand Down
6 changes: 3 additions & 3 deletions docs/native-libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.1/.circleci/expected_journal.txt
.. _Mac OS X journal: https://github.com/dhermes/bezier/blob/0.6.1/scripts/osx/travis_journal.txt
.. _Windows journal: https://github.com/dhermes/bezier/blob/0.6.1/appveyor/expected_journal.txt

***************************
Building a Python Extension
Expand Down

0 comments on commit 87a7b8d

Please sign in to comment.