Pablo Piskunow authored 8 years ago and Joseph Weston committed 8 years ago

the '_defs' module is used solely when generating images
within the tutorial part of the documentation.

Tómas authored 8 years ago and Joseph Weston committed 8 years ago

Uses the new conservation law and discrete symmetry interface
to Builder, and illustrates the separation of the scattering matrix into
blocks depending on conservation law eigenvalue.

Also improve the documentation for operators in general.

special methods are not included by autodocs by default, and
as class documentation pages are generated by autosummary,
we cannot just explicitly include __call__. We get around this
by using a custom autosummary template for the operator classes.

For cython extension modules, the method signature for __call__
is still not embedded properly.
See https://github.com/cython/cython/issues/1577.

Summary of changes:
* Add a test for trailing whitespace, remove all trailling whitespace
* Add a test for broken URLs in docs, fix all broken URLs and permanent redirects
* Switch sphinx doc build to strict (warnings to errors) and nitpicky (broken links to warnings). Fix all sphinx warnings.
* Deploy docs from any commit to [kwant/kwant](https://gitlab.kwant-project.org/kwant/kwant) to https://test.kwant-project.org/doc/dev
* Deploy docs from any commit to master at kwant/kwant to https://kwant-project.org/doc/dev
* Deploy docs from any tag release tag (so anything that is vX.Y.Z) at kwant/kwant to https://kwant-project.org/doc/X.Y

The date is currently missing, and should be provided before
an official release is made.

fixes #36

this fixes #35

Christoph Groth authored 9 years ago and Anton Akhmerov committed 9 years ago

Co-authored by Anton Akhmerov <anton.akhmerov@gmail.com>

Running 2to3 removed a line in the graphene.py tutorial script, which
broke the diff file. We manually update the diff file to fix this.