[Numpy-svn] [numpy/numpy] 6646bd: DOC: Fix outdated sphinx directives.

GitHub noreply at github.com
Thu Jul 2 03:56:29 EDT 2015


  Branch: refs/heads/master
  Home:   https://github.com/numpy/numpy
  Commit: 6646bdfeac189c50b19b032ea8b6795ea7fd2074
      https://github.com/numpy/numpy/commit/6646bdfeac189c50b19b032ea8b6795ea7fd2074
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M doc/source/reference/arrays.interface.rst
    M doc/source/reference/arrays.scalars.rst
    M doc/source/reference/c-api.array.rst
    M doc/source/reference/c-api.config.rst
    M doc/source/reference/c-api.coremath.rst
    M doc/source/reference/c-api.dtype.rst
    M doc/source/reference/c-api.iterator.rst
    M doc/source/reference/c-api.types-and-structures.rst
    M doc/source/reference/c-api.ufunc.rst
    M doc/source/reference/internals.code-explanations.rst
    M doc/source/user/c-info.beyond-basics.rst
    M doc/source/user/c-info.how-to-extend.rst
    M doc/source/user/c-info.ufunc-tutorial.rst

  Log Message:
  -----------
  DOC: Fix outdated sphinx directives.

Examples

:cdata: -> :c:data:
.. cfunction:: -> .. c:function::


  Commit: 430a3796e11dd11bdc3db7838ff1bcf159105978
      https://github.com/numpy/numpy/commit/430a3796e11dd11bdc3db7838ff1bcf159105978
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M numpy/lib/info.py

  Log Message:
  -----------
  DOC: Add reference to new stack function in numpy/lib/info.py.


  Commit: 1393a575c58f1ba86b1684ba9677ad134d057a93
      https://github.com/numpy/numpy/commit/1393a575c58f1ba86b1684ba9677ad134d057a93
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M doc/source/reference/arrays.ndarray.rst
    M numpy/add_newdocs.py
    M numpy/matrixlib/tests/test_defmatrix.py

  Log Message:
  -----------
  DOC: Remove references to removed setasflat ndarray method.


  Commit: 276a4e1c27f17cca30ae0c0775fe03bd4b46af35
      https://github.com/numpy/numpy/commit/276a4e1c27f17cca30ae0c0775fe03bd4b46af35
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M doc/source/reference/arrays.ndarray.rst

  Log Message:
  -----------
  DOC: Fix list markup in source/reference/arrays.ndarray.rst.

List needs to be preceded by blank line.


  Commit: a70842c58b11b4c3e56425d67e075a418db361f4
      https://github.com/numpy/numpy/commit/a70842c58b11b4c3e56425d67e075a418db361f4
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M doc/source/reference/arrays.classes.rst
    M doc/source/reference/arrays.ndarray.rst

  Log Message:
  -----------
  DOC: Remove a reference to __array_priority__.

Also correct its documented default value.


  Commit: dd5fd83164e74523b44b0e8bfbc9054ee19a8db5
      https://github.com/numpy/numpy/commit/dd5fd83164e74523b44b0e8bfbc9054ee19a8db5
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M doc/source/reference/index.rst

  Log Message:
  -----------
  DOC: Remove reference to routines.ctypeslib.rst from index.rst.

The proper reference is in routines.rst.


  Commit: f940a9e434e2ba39328361336711502895a42194
      https://github.com/numpy/numpy/commit/f940a9e434e2ba39328361336711502895a42194
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M doc/source/reference/internals.code-explanations.rst

  Log Message:
  -----------
  DOC: Fix bad rst list formats in internals.code-explanations.rst.

The lists needed blank lines before starting.


  Commit: f5e9adbbf87903e42d03bb3dd5f86b70a89e930c
      https://github.com/numpy/numpy/commit/f5e9adbbf87903e42d03bb3dd5f86b70a89e930c
  Author: Charles Harris <charlesr.harris at gmail.com>
  Date:   2015-07-01 (Wed, 01 Jul 2015)

  Changed paths:
    M numpy/add_newdocs.py
    M numpy/core/defchararray.py
    M numpy/core/fromnumeric.py
    M numpy/core/numeric.py
    M numpy/distutils/exec_command.py
    M numpy/doc/glossary.py
    M numpy/lib/arraysetops.py
    M numpy/lib/function_base.py
    M numpy/lib/npyio.py
    M numpy/linalg/linalg.py
    M numpy/ma/extras.py
    M numpy/random/mtrand/mtrand.pyx

  Log Message:
  -----------
  DOC: Fix docstring warnings in documetation generation.

Most of these fixes involve putting blank lines around

.. versionadded:: x.x.x

and

.. deprecated:: x.x.x

Some of the examples were also fixed.


  Commit: 7a3926c45f99284c83eeefb4e87030139b3d689b
      https://github.com/numpy/numpy/commit/7a3926c45f99284c83eeefb4e87030139b3d689b
  Author: Nathaniel J. Smith <njs at pobox.com>
  Date:   2015-07-02 (Thu, 02 Jul 2015)

  Changed paths:
    M doc/source/reference/arrays.classes.rst
    M doc/source/reference/arrays.interface.rst
    M doc/source/reference/arrays.ndarray.rst
    M doc/source/reference/arrays.scalars.rst
    M doc/source/reference/c-api.array.rst
    M doc/source/reference/c-api.config.rst
    M doc/source/reference/c-api.coremath.rst
    M doc/source/reference/c-api.dtype.rst
    M doc/source/reference/c-api.iterator.rst
    M doc/source/reference/c-api.types-and-structures.rst
    M doc/source/reference/c-api.ufunc.rst
    M doc/source/reference/index.rst
    M doc/source/reference/internals.code-explanations.rst
    M doc/source/user/c-info.beyond-basics.rst
    M doc/source/user/c-info.how-to-extend.rst
    M doc/source/user/c-info.ufunc-tutorial.rst
    M numpy/add_newdocs.py
    M numpy/core/defchararray.py
    M numpy/core/fromnumeric.py
    M numpy/core/numeric.py
    M numpy/distutils/exec_command.py
    M numpy/doc/glossary.py
    M numpy/lib/arraysetops.py
    M numpy/lib/function_base.py
    M numpy/lib/info.py
    M numpy/lib/npyio.py
    M numpy/linalg/linalg.py
    M numpy/ma/extras.py
    M numpy/matrixlib/tests/test_defmatrix.py
    M numpy/random/mtrand/mtrand.pyx

  Log Message:
  -----------
  Merge pull request #6035 from charris/documentation-maintenance

Documentation fixes.


Compare: https://github.com/numpy/numpy/compare/61d2a445881f...7a3926c45f99


More information about the Numpy-svn mailing list