Skip to content

Commit

Permalink
Restore docs to "latest" configuration after tag was pushed.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhermes committed Sep 7, 2017
1 parent 1b13a00 commit 75692f4
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 41 deletions.
32 changes: 16 additions & 16 deletions DEVELOPMENT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,32 +185,32 @@ To run the functional tests:
$ MATPLOTLIBRC=test/ pypy -m pytest functional_tests/
$ unset PYTHONPATH
.. _functional tests: https://github.com/dhermes/bezier/tree/0.5.0/functional_tests
.. _functional tests: https://github.com/dhermes/bezier/tree/master/functional_tests

For example, the following curve-curve intersection is a
functional test case:

.. image:: https://raw.githubusercontent.com/dhermes/bezier/0.5.0/docs/images/curves11_and_26.png
.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/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/0.5.0/curve-curve-intersection.html
.. _Curve-Curve Intersection: https://bezier.readthedocs.io/en/latest/curve-curve-intersection.html

A surface-surface intersection functional test case:

.. image:: https://raw.githubusercontent.com/dhermes/bezier/0.5.0/docs/images/surfaces1Q_and_2Q.png
.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/surfaces1Q_and_2Q.png
:align: center

a segment-box functional test case:

.. image:: https://raw.githubusercontent.com/dhermes/bezier/0.5.0/docs/images/test_goes_through_box08.png
.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/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/0.5.0/docs/images/test_surface3_and_point1.png
.. image:: https://raw.githubusercontent.com/dhermes/bezier/master/docs/images/test_surface3_and_point1.png
:align: center

Functional Test Data
Expand All @@ -228,10 +228,10 @@ This way, the test cases are programming language agnostic and can be
repurposed. The `JSON schema`_ for these files are stored in the
``functional_tests/schema`` directory.

.. _curves.json: https://github.com/dhermes/bezier/blob/0.5.0/functional_tests/curves.json
.. _curve_intersections.json: https://github.com/dhermes/bezier/blob/0.5.0/functional_tests/curve_intersections.json
.. _surfaces.json: https://github.com/dhermes/bezier/blob/0.5.0/functional_tests/surfaces.json
.. _surface_intersections.json: https://github.com/dhermes/bezier/blob/0.5.0/functional_tests/surface_intersections.json
.. _curves.json: https://github.com/dhermes/bezier/blob/master/functional_tests/curves.json
.. _curve_intersections.json: https://github.com/dhermes/bezier/blob/master/functional_tests/curve_intersections.json
.. _surfaces.json: https://github.com/dhermes/bezier/blob/master/functional_tests/surfaces.json
.. _surface_intersections.json: https://github.com/dhermes/bezier/blob/master/functional_tests/surface_intersections.json
.. _JSON schema: http://json-schema.org/

************
Expand All @@ -254,7 +254,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/0.5.0/pylintrc
.. _pylintrc: https://github.com/dhermes/bezier/blob/master/pylintrc

Docstring Style
===============
Expand Down Expand Up @@ -368,10 +368,10 @@ Python versions we test in. The image used in our CircleCI builds (from

.. _CircleCI: https://circleci.com/gh/dhermes/bezier
.. _AppVeyor: https://ci.appveyor.com/project/dhermes/bezier
.. _CircleCI config: https://github.com/dhermes/bezier/blob/0.5.0/.circleci/config.yml
.. _AppVeyor config: https://github.com/dhermes/bezier/blob/0.5.0/.appveyor.yml
.. _python-multi Dockerfile: https://github.com/dhermes/bezier/blob/0.5.0/scripts/docker/python-multi.Dockerfile
.. _bezier Dockerfile: https://github.com/dhermes/bezier/blob/0.5.0/scripts/docker/bezier.Dockerfile
.. _CircleCI config: https://github.com/dhermes/bezier/blob/master/.circleci/config.yml
.. _AppVeyor config: https://github.com/dhermes/bezier/blob/master/.appveyor.yml
.. _python-multi Dockerfile: https://github.com/dhermes/bezier/blob/master/scripts/docker/python-multi.Dockerfile
.. _bezier Dockerfile: https://github.com/dhermes/bezier/blob/master/scripts/docker/bezier.Dockerfile

**********************
Deploying New Versions
Expand Down Expand Up @@ -419,7 +419,7 @@ Supported Python Versions

Supported versions can be found in the ``nox.py`` `config`_.

.. _config: https://github.com/dhermes/bezier/blob/0.5.0/nox.py
.. _config: https://github.com/dhermes/bezier/blob/master/nox.py

Versioning
==========
Expand Down
44 changes: 26 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

|circle-build| |appveyor-build| |coverage|

|pypi| |versions|

|docs| |zenodo| |JOSS|

.. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE
Expand All @@ -17,7 +19,7 @@ This library provides:

Dive in and take a look!

.. image:: https://cdn.rawgit.com/dhermes/bezier/0.5.0/docs/images/surfaces6Q_and_7Q.png
.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/surfaces6Q_and_7Q.png
:align: center

Why B |eacute| zier?
Expand All @@ -26,17 +28,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/0.5.0/docs/images/bernstein_basis.png
.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/bernstein_basis.png
:align: center

to define a curve as a linear combination:

.. image:: https://cdn.rawgit.com/dhermes/bezier/0.5.0/docs/images/bezier_defn.png
.. image:: https://cdn.rawgit.com/dhermes/bezier/master/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/0.5.0/docs/images/sum_to_unity.png
.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/sum_to_unity.png
:align: center

This can be generalized to higher order by considering three, four, etc.
Expand Down Expand Up @@ -140,7 +142,7 @@ intersections):
>>> _ = ax.set_ylim(-0.0625, 0.625)
>>> plt.show()
.. image:: https://cdn.rawgit.com/dhermes/bezier/0.5.0/docs/images/curves1_and_13.png
.. image:: https://cdn.rawgit.com/dhermes/bezier/master/docs/images/curves1_and_13.png
:align: center

For API-level documentation, check out the B |eacute| zier
Expand All @@ -159,23 +161,29 @@ License
``bezier`` is made available under the Apache 2.0 License. For more
details, see `the LICENSE`_.

.. _Curves: https://bezier.readthedocs.io/en/0.5.0/reference/bezier.curve.html
.. _Surfaces: https://bezier.readthedocs.io/en/0.5.0/reference/bezier.surface.html
.. _Package: https://bezier.readthedocs.io/en/0.5.0/reference/bezier.html
.. _DEVELOPMENT doc: https://github.com/dhermes/bezier/blob/0.5.0/DEVELOPMENT.rst
.. _the LICENSE: https://github.com/dhermes/bezier/blob/0.5.0/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

.. |docs| image:: https://readthedocs.org/projects/bezier/badge/?version=0.5.0
:target: https://bezier.readthedocs.io/en/0.5.0/
.. |docs| image:: https://readthedocs.org/projects/bezier/badge/?version=latest
:target: https://bezier.readthedocs.io/en/latest/
:alt: Documentation Status
.. |circle-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.5.0/docs/circleci-passing.svg
:target: https://circleci.com/gh/dhermes/bezier/697
.. |circle-build| image:: https://circleci.com/gh/dhermes/bezier.svg?style=shield
:target: https://circleci.com/gh/dhermes/bezier
:alt: CircleCI Build
.. |appveyor-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.5.0/docs/appveyor-passing.svg
:target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.430.master
.. |appveyor-build| image:: https://ci.appveyor.com/api/projects/status/github/dhermes/bezier?svg=true
:target: https://ci.appveyor.com/project/dhermes/bezier
:alt: AppVeyor CI Build
.. |coverage| image:: https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_100.svg
:target: https://coveralls.io/builds/13176599
.. |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
:alt: Code Coverage
.. |zenodo| image:: https://zenodo.org/badge/73047402.svg
:target: https://zenodo.org/badge/latestdoi/73047402
Expand Down
22 changes: 15 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

|circle-build| |appveyor-build| |coverage|

|pypi| |versions|

|zenodo| |JOSS|

.. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE
Expand Down Expand Up @@ -199,16 +201,22 @@ 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/0.5.0/LICENSE
.. _the LICENSE: https://github.com/dhermes/bezier/blob/master/LICENSE

.. |circle-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.5.0/docs/circleci-passing.svg
:target: https://circleci.com/gh/dhermes/bezier/697
.. |circle-build| image:: https://circleci.com/gh/dhermes/bezier.svg?style=shield
:target: https://circleci.com/gh/dhermes/bezier
:alt: CircleCI Build
.. |appveyor-build| image:: https://cdn.rawgit.com/dhermes/bezier/0.5.0/docs/appveyor-passing.svg
:target: https://ci.appveyor.com/project/dhermes/bezier/build/1.0.430.master
.. |appveyor-build| image:: https://ci.appveyor.com/api/projects/status/github/dhermes/bezier?svg=true
:target: https://ci.appveyor.com/project/dhermes/bezier
:alt: AppVeyor CI Build
.. |coverage| image:: https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_100.svg
:target: https://coveralls.io/builds/13176599
.. |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
:alt: Code Coverage
.. |zenodo| image:: https://zenodo.org/badge/73047402.svg
:target: https://zenodo.org/badge/latestdoi/73047402
Expand Down

0 comments on commit 75692f4

Please sign in to comment.