Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Sphincs-based documentation #130

Merged
merged 73 commits into from
Mar 26, 2019
Merged

Add Sphincs-based documentation #130

merged 73 commits into from
Mar 26, 2019

Commits on Mar 23, 2019

  1. Run sphinx-quickstart

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    820dc4d View commit details
    Browse the repository at this point in the history

  2. README: Miscellaneous improvements in API description

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    a866e64 View commit details
    Browse the repository at this point in the history

  3. Start moving API documentation from README to docstrings

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    c8ecf0c View commit details
    Browse the repository at this point in the history

  4. README: Slight improvement

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    da86482 View commit details
    Browse the repository at this point in the history

  5. Vector2: Add a class docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    0515851 View commit details
    Browse the repository at this point in the history

  6. Vector2.convert: Improve docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    b8dd905 View commit details
    Browse the repository at this point in the history

  7. Use RTD theme

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    f24a6cb View commit details
    Browse the repository at this point in the history

  8. Add docs requirements

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    7de90f5 View commit details
    Browse the repository at this point in the history

  9. docs: Generate docs for Vector2 using autoclass 

    Also, remove the useless Table of Contents
    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    cb0b0b6 View commit details
    Browse the repository at this point in the history

  10. Vector2: Remove installation instructions from the class docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    131d34b View commit details
    Browse the repository at this point in the history

  11. Vector2: Start converting docstrings to rst markup

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    9c78c0f View commit details
    Browse the repository at this point in the history

  12. Add intersphinx to core python docs

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    54ecf23 View commit details
    Browse the repository at this point in the history

  13. Add sphinx_autodoc_annotation

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    c60537c View commit details
    Browse the repository at this point in the history

  14. Merge pull request #128 from nbraud/pydoc 

    Add the docstrings work to the Sphinx branch
    @AstraLuma
    AstraLuma authored Mar 23, 2019
    Configuration menu
    Copy the full SHA
    5cd676f View commit details
    Browse the repository at this point in the history

  15. docs: Add missing dependency on sphinx_rtd_theme

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    8856b7b View commit details
    Browse the repository at this point in the history

  16. Vector2: Add markup for references in the docstrings

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    0e9b47f View commit details
    Browse the repository at this point in the history

  17. docs: Vector2: Add special members, because operators are pretty impo… 

    …rtant to this type
    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    14cb33f View commit details
    Browse the repository at this point in the history

  18. Better docs for Vector2.update

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    da9fff0 View commit details
    Browse the repository at this point in the history

  19. Rename the VectorOrSub type variable to Vector

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    0136075 View commit details
    Browse the repository at this point in the history

  20. Vector2.convert: Fix inter-Sphinx references to Mapping and Sequence

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    7267ce8 View commit details
    Browse the repository at this point in the history

  21. Vector2.scale_by: Rename parameter to scalar (from other)

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    08bde42 View commit details
    Browse the repository at this point in the history

  22. README: Bring back dunder operators (Sphinx doesn't render them)

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    f9260e4 View commit details
    Browse the repository at this point in the history

  23. fixup! Vector2.scale_by: Rename parameter to scalar (from other)

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    8d57326 View commit details
    Browse the repository at this point in the history

  24. README: Use more operators for examples introducing vector-likes

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    53930fc View commit details
    Browse the repository at this point in the history

  25. Revert "README: Bring back dunder operators (Sphinx doesn't render th… 

    …em)"

This reverts commit f9260e4.
    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    b106a7d View commit details
    Browse the repository at this point in the history

  26. docs: Vector2: Document .x and .y

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    2ccc387 View commit details
    Browse the repository at this point in the history

  27. Remove .scale from docs

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    ad47824 View commit details
    Browse the repository at this point in the history

  28. Vector2.isclose: Grab the documentation from the README 

    The pre-existing docstring was noticeably less good than the README.
    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    66c0af3 View commit details
    Browse the repository at this point in the history

  29. Vector2: Properly format variable names in docstrings

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    edb9733 View commit details
    Browse the repository at this point in the history

  30. docs: Annotate types of .x and .y

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    739d5af View commit details
    Browse the repository at this point in the history

  31. Merge branch 'sphinx' of github.com:ppb/ppb-vector into sphinx

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    74f3936 View commit details
    Browse the repository at this point in the history

  32. docs: Document the Vector typevar

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    b8da55f View commit details
    Browse the repository at this point in the history

  33. docs/Vector2: Sort the exclude-members list

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    36cabf3 View commit details
    Browse the repository at this point in the history

  34. docs/Vector2: Do not autogenerate doc for __repr__

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    e25920b View commit details
    Browse the repository at this point in the history

  35. Vector2.__truediv__: Add example in docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    e86e8c2 View commit details
    Browse the repository at this point in the history

  36. Add examples for .convert()

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    24ddea2 View commit details
    Browse the repository at this point in the history

  37. Vector2.__mul__: Move the documentation to a docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    bdb974f View commit details
    Browse the repository at this point in the history

  38. README: Link to the RTD documentation

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    3dc443c View commit details
    Browse the repository at this point in the history

  39. Add docs about Vector2 being sequence-ish and mapping-ish

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    2a63fd6 View commit details
    Browse the repository at this point in the history

  40. normalize: Remove errant comma

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    9692fd9 View commit details
    Browse the repository at this point in the history

  41. Vector2: Reference vector-likes in each relevant method docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    73543f1 View commit details
    Browse the repository at this point in the history

  42. Vector2.dot: Terser description

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    1b87499 View commit details
    Browse the repository at this point in the history

  43. Vector2.scale_by: Add example, document infix notation

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    b82b597 View commit details
    Browse the repository at this point in the history

  44. Vector2.reflect: Reflow text in docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    aa6e723 View commit details
    Browse the repository at this point in the history

  45. fixup! Vector2.scale_by: Add example, document infix notation

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    2f05e62 View commit details
    Browse the repository at this point in the history

  46. Vector2: Provide proper code examples for unpacking, and accessing

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    d74cdab View commit details
    Browse the repository at this point in the history

  47. README: Drop the documentation of “convenience functions” 

    Those are now documented in the class-level docstring.
    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    54336e9 View commit details
    Browse the repository at this point in the history

  48. Work on the Vector typevar

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    dea1c9e View commit details
    Browse the repository at this point in the history

  49. README: Drop documentation of “Mathematical operators” 

    Each operator's docstring refers to `convert()` for describing vector-likes, and
provides a code example using a vector-like.
    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    14752b1 View commit details
    Browse the repository at this point in the history

  50. docs: Add an annotation to Vector with the actual declaration

    @AstraLuma
    AstraLuma committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    941d1b1 View commit details
    Browse the repository at this point in the history

  51. Vector2.__eq__: Reference convert()/vector-like in docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    8a85914 View commit details
    Browse the repository at this point in the history

  52. Vector2.__eq__: Drop the ambiguous & unhelpful definition 

    It can easily be misunderstood as “equals if the x and y coordinates are equal”.

Moreover, it's not particularly useful: ppb-vector is meant to be easy to use,
but it is not meant to be a basic course on 2D geometry.
    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    ed127db View commit details
    Browse the repository at this point in the history

  53. docs/Vector: Add a cross-reference to typing.TypeVar

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    158cf09 View commit details
    Browse the repository at this point in the history

  54. docs/Vector: Fix minor typo

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    af39e54 View commit details
    Browse the repository at this point in the history

  55. docs: Change title to “PPB's 2D Vector class”

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    cb4c3e8 View commit details
    Browse the repository at this point in the history

  56. Cirrus CI: Add a task for building documentation

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    f057795 View commit details
    Browse the repository at this point in the history

  57. fixup! Cirrus CI: Add a task for building documentation

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    5fc3584 View commit details
    Browse the repository at this point in the history

  58. fixup! Cirrus CI: Add a task for building documentation

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    e815e72 View commit details
    Browse the repository at this point in the history

  59. Vector2: Add cross-references to the relevant protocols in docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    a52160a View commit details
    Browse the repository at this point in the history

  60. Vector2: Sort [indexing, unpacking] in class docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    b09e3fd View commit details
    Browse the repository at this point in the history

  61. Vector2: Add examples of conversions to lists and tuples

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    470ee19 View commit details
    Browse the repository at this point in the history

  62. Vector2.asdict: Add docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    c687b20 View commit details
    Browse the repository at this point in the history

  63. Vector2: Move comparison of scale and normalize to the latter's doc

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    8c5e70b View commit details
    Browse the repository at this point in the history

  64. Vector2.normalize: Replace redundant display with assert in example

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    cdc00a7 View commit details
    Browse the repository at this point in the history

  65. Revert "Vector2: Add cross-references to the relevant protocols in do… 

    …cstring"

This reverts commit a52160a.
    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    5d31e92 View commit details
    Browse the repository at this point in the history

  66. Vector2.isclose: Replace outputting True with an assertion

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    83f6612 View commit details
    Browse the repository at this point in the history

  67. Vector2: Fix indentation in class docstring

    @nbraud
    nbraud committed Mar 23, 2019
    Configuration menu
    Copy the full SHA
    811f6b9 View commit details
    Browse the repository at this point in the history

Commits on Mar 24, 2019

  1. docs/Vector: Clarify what Vector is used for.

    @nbraud
    nbraud committed Mar 24, 2019
    Configuration menu
    Copy the full SHA
    d51a958 View commit details
    Browse the repository at this point in the history

  2. Cirrus CI: Do not perform builds for Bors' temporary branches

    @nbraud
    nbraud committed Mar 24, 2019
    Configuration menu
    Copy the full SHA
    f6d1e41 View commit details
    Browse the repository at this point in the history

  3. Bors: Configure required CI checks 

    All tests and lint tasks, except for CPython 3.8-rc.

`docs` will need to be added once #130 lands.
    @nbraud
    nbraud committed Mar 24, 2019
    Configuration menu
    Copy the full SHA
    554f4c0 View commit details
    Browse the repository at this point in the history

  4. Merge branch 'qa/bors' into sphinx

    @nbraud
    nbraud committed Mar 24, 2019
    Configuration menu
    Copy the full SHA
    2418d64 View commit details
    Browse the repository at this point in the history

  5. Cirrus CI: Do not build docs on Bors temporary branches

    @nbraud
    nbraud committed Mar 24, 2019
    Configuration menu
    Copy the full SHA
    41b34d5 View commit details
    Browse the repository at this point in the history

  6. Bors: Require docs to build successfully

    @nbraud
    nbraud committed Mar 24, 2019
    Configuration menu
    Copy the full SHA
    7d56285 View commit details
    Browse the repository at this point in the history