Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Fix for building with sphinx 3 #16370

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

Merged
merged 1 commit into from
Dec 16, 2020
Merged

DOC: Fix for building with sphinx 3 #16370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import sys

# Minimum version, enforced by sphinx
needs_sphinx = '2.2.0'
needs_sphinx = '3.2.0'


# This is a nasty hack to use platform-agnostic names for types in the
Expand Down Expand Up @@ -146,6 +146,14 @@ def setup(app):
app.add_config_value('python_version_major', str(sys.version_info.major), 'env')
app.add_lexer('NumPyC', NumPyLexer)

# While these objects do have type `module`, the names are aliases for modules
# elsewhere. Sphinx does not support referring to modules by an aliases name,
# so we make the alias look like a "real" module for it.
# If we deemed it desirable, we could in future make these real modules, which
# would make `from numpy.char import split` work.
sys.modules['numpy.char'] = numpy.char
sys.modules['numpy.testing.dec'] = numpy.testing.dec

# -----------------------------------------------------------------------------
# HTML output
# -----------------------------------------------------------------------------
Expand Down
99 changes: 66 additions & 33 deletions doc/source/reference/arrays.scalars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,112 +94,141 @@ Python Boolean scalar.
.. tip:: The default data type in NumPy is :class:`float_`.

.. autoclass:: numpy.generic
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.number
:exclude-members:
:members: __init__
:exclude-members: __init__

Integer types
~~~~~~~~~~~~~

.. autoclass:: numpy.integer
:exclude-members:
:members: __init__
:exclude-members: __init__

Signed integer types
++++++++++++++++++++

.. autoclass:: numpy.signedinteger
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.byte
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.short
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.intc
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.int_
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.longlong
:exclude-members:
:members: __init__
:exclude-members: __init__

Unsigned integer types
++++++++++++++++++++++

.. autoclass:: numpy.unsignedinteger
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.ubyte
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.ushort
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.uintc
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.uint
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.ulonglong
:exclude-members:
:members: __init__
:exclude-members: __init__

Inexact types
~~~~~~~~~~~~~

.. autoclass:: numpy.inexact
:exclude-members:
:members: __init__
:exclude-members: __init__

Floating-point types
++++++++++++++++++++

.. autoclass:: numpy.floating
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.half
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.single
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.double
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.longdouble
:exclude-members:
:members: __init__
:exclude-members: __init__

Complex floating-point types
++++++++++++++++++++++++++++

.. autoclass:: numpy.complexfloating
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.csingle
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.cdouble
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.clongdouble
:exclude-members:
:members: __init__
:exclude-members: __init__

Other types
~~~~~~~~~~~

.. autoclass:: numpy.bool_
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.datetime64
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.timedelta64
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.object_
:exclude-members:
:members: __init__
:exclude-members: __init__

.. note::

Expand All @@ -222,16 +251,20 @@ arrays. (In the character codes ``#`` is an integer denoting how many
elements the data type consists of.)

.. autoclass:: numpy.flexible
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.bytes_
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.str_
:exclude-members:
:members: __init__
:exclude-members: __init__

.. autoclass:: numpy.void
:exclude-members:
:members: __init__
:exclude-members: __init__


.. warning::
Expand Down
Loading