summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* DOC: mv meta landing page to index.rst.Ross Barnowski2021-02-261-1/+1
| | | | | | | | The current master_doc is really only used to specify the toctree to set up the navbar in the pydata-sphinx-theme. By renaming to index.rst the navbar config is preserved and the links back to the main page point to the original landing page rather than the contents page, which was mostly empty.
* DOC: point intersphinx to matplotlib/stable...Jody Klymak2021-02-161-1/+1
| | | matplotlib canonical docs are now https://matplotlib.org/stable
* DOC: Change license date 2020 -> 2021 (gh-18346)Aerysv2021-02-061-1/+1
| | | A very small contribution to update the license date from 2020 to 2021 :)
* DOC: remove pygments_style from conf.pyMatthias Geier2021-02-051-3/+0
|
* DOC: Fix for buildling with sphinx 3takanori-pskq2020-11-061-1/+9
|
* Merge pull request #17331 from eric-wieser/remove-scalar-tablesMatti Picus2020-10-061-12/+87
|\ | | | | DOC: Remove the tables of scalar types, and use `..autoclass` to create link targets instead
| * DOC: Change the value of type.__name__ on the scalar types for sphinx buildsEric Wieser2020-10-041-0/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | By default, the `.__name__` of the numeric `np.generic` subclasses is their bitlength name, such as `np.int64`. This is convenient when working interactively, because it lets users see the size of their array easily; but in docs it is confusing, as the sizes of the integers in the doc build may not match their size on the platform of the user reading them. Without this change, `..autoclass:: numpy.short` would just display "alias of uint16", which is backwards. Rather than changing the names globally, or adding a build flag to change the names, this uses `ctypes` to modify the scalar names at startup. This resembles the approach taken by the `forbiddenfruit` module for patching builtin slots, although that would be overkill here. The timing of when we perform this patching is important - we can't do it until after `numpy.core._umath_multiarray` has been loaded, but we need to do it before `numpy.core._add_newdocs` generates the name-based docstrings. Similarly, we can't just disable `numpy.core._add_newdocs` until later, as it populates docstrings in `ndarray` on which `numpy.ma.core` does further processing. To resolve this, we split out the scalar docstrings in `numpy.core._add_newdocs` into a new module `numpy.core._add_newdocs_scalars` that _is_ safe to disable until later.
| * DOC: Improve [source] links for C extension typesEric Wieser2020-10-041-12/+31
| | | | | | | | | | | | Previously, these would all link to `numpy/core/__init__.py`. Now the scalar type and `ndarray` link to the files where the `PyTypeObject` is defined. In future, we should do this for all extension types, probably automatically.
* | DOC: History cleanup for #17353Ben Nathanson2020-09-231-0/+2
|/
* Update doc/source/conf.pyMatti Picus2020-09-161-1/+1
| | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* DOC, BLD: fix templated C highlightingmattip2020-09-161-8/+8
|
* DOC: first step toward switching themesmattip2020-08-141-28/+9
|
* Fixing RemovedInSphinx40WarningBrigitta Sipocz2020-07-121-1/+1
|
* DOC: Use intersphinx for NEP referencesBen Nathanson2020-06-041-1/+2
| | | | | | | | | | | | | Per #16500 discussion, adds link updates to PR. Replaces NEP URLs with intersphinx links in these files: * doc/HOWTO_RELEASE.rst.txt * doc/source/dev/howto-docs.rst * numpy/doc/dispatch.py * numpy/lib/format.py and incorporates @rossbar's #16502 change of `config.py`.
* DOC,BLD: Update sphinx conf to use xelatex.Ross Barnowski2020-05-271-0/+3
| | | | | Switch from pdflatex to xelatex as the latex engine used for generating the latex/pdf version of the documentation.
* DOC: Change license date 2019 -> 2020 (gh-15735)Himanshu Garg2020-03-101-1/+1
| | | Update Year 2019 -> 2020
* Merge pull request #15295 from melissawm/linalg-tutorialMatti Picus2020-02-281-1/+3
|\ | | | | DOC: Added tutorial about linear algebra on multidimensional arrays
| * Added intersphinx mappings for skimage and imageio; added proper links to ↵melissawm2020-02-271-1/+3
| | | | | | | | external docs.
* | MAINT: cleanup unused imports; avoid redefinition of importsMike Taves2020-02-061-2/+0
| | | | | | | | | | | | | | * Cleanup unused imports (F401) of mostly standard Python modules, or some internal but unlikely referenced modules * Where internal imports are potentially used, mark with noqa * Avoid redefinition of imports (F811)
* | STY,MAINT: avoid 'multiple imports on one line' (flake8 E401)Mike Taves2020-01-281-1/+3
| | | | | | | | | | | | * PEP 8: "Imports should usually be on separate lines" * Where modified, sort imported modules alphabetically * Clean-up unused imports from these expanded lines
* | DOC: NumPy for absolute beginners tutorial (#14546)Anne Bonner2020-01-211-0/+1
|/ | | | | | | This absolute beginners tutorial is the output of Anne's Google Season of Docs project. An intermediate version was also published at https://towardsdatascience.com/the-ultimate-beginners-guide-to-numpy-f5a2f99aef54
* MAINT: Remove unnecessary 'from __future__ import ...' statementsJon Dufresne2020-01-031-2/+0
| | | | | As numpy is Python 3 only, these import statements are now unnecessary and don't alter runtime behavior.
* [DOC] LaTeX: Fix preamblejfbu2019-12-021-4/+17
| | | | | | | | | | | Memo: latex_preamble got removed from Sphinx at 1.6.1, and old LaTeX package expdlist requires a fix else it breaks LaTeX if a description list is in a table cell, and it causes anyhow many LaTeX complaints about Underfull box (badness 10000). The fix for these complaints is copied over from https://github.com/scipy/scipy/commit/c881fdea7a7ef7c518b789 and it turns out it is also a fix for the crash in case a description list is in a table..
* DOC, BUILD: use sphinx 2.2.0, add autosummary/base.rst for propertiesmattip2019-09-151-1/+1
|
* DOC: support and require sphinx>=2.1.2Christopher Whelan2019-09-141-15/+12
|
* DOC: remove scipy.org from the breadcrumb formattiongmattip2019-08-131-1/+0
|
* DOC: add backlinks to numpy.orgmattip2019-08-081-1/+4
|
* DOC: add a NumPyC syntax format that accepts our preprocessor @TYPE@ macrosmattip2019-06-101-0/+17
|
* ENH: Add closed generator to randintKevin Sheppard2019-05-201-4/+0
| | | | Add closed option to randint to simplify some cases
* BUILD: move files out of _randomgenmattip2019-05-201-6/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | first cut at building randomgen upgrade 'cythonize' and fix absolute imports to relative define NPY_NO_DEPRECATED_API and fix other warnings enable pgc64 by always using PCG_EMULATED_MATH refactor so import randomgen works add TODO comments for pcg64 improvements fix imports, module name in setup.py; remove _testing make cythonize non-recursive, restore examples to proper place update to randomgen 7bca296c0b9 replace mtrand with LegacyGenerator, tweak for compatibility port f879ef4 to fix GH10839 minimized difference between generator.pyx and _legacy.pyx fix namespace in doctests, mark results that are random update to randomgen commit 95c8cdd1c Incorporate testing of edge cases into main tests Rename test files to describe their purpose Import import locations to reflect numpy paths Correct tolerance on float32 tests Remove set_printoptions Remove complex normal Remove future imports Pull in BasicRNG source changes from original author Small doc fixes _mtrand => _rand Improve consistency of nan handling Prevent nans prducing values from int functions add randomgen documentation to the tree
* DOC: update 2018 -> 2019mattip2019-01-011-1/+1
|
* BUG: Fix doc source links to unwrap decoratorsEric Wieser2018-07-311-0/+9
| | | | Fixes #11639, relates to https://bugs.python.org/issue1764286
* HTTP -> HTTPS, and other linkrot fixesMike Toews2018-06-161-4/+4
|
* Added a modified version of the basic Sphinx search boxAlex Thomas2018-04-211-1/+1
|
* DOC: clear up warnings, fix matplotlib plotmattip2018-04-171-1/+1
|
* render the example in numpydoc, add ifconfig for host python major versionmattip2018-04-131-1/+4
|
* update copyright yearmattip2018-04-111-1/+1
|
* Replace sphinx extension sphinx.ext.pngmath by sphinx.ext.imgmath.Kexuan Sun2017-11-251-2/+3
|
* Changed sphinx extension sphinx.ext.pngmath to sphinx.ext.imgmath.Kexuan Sun2017-11-211-1/+7
|
* DOC: removes broken docstring example (source code, png, pdf) linksJames Bourbeau2017-08-131-0/+2
| | | | | | Currently the (source code, png, pdf) links for docstring examples are pointing to missing files and give 404 errors (see issue #9500). This commit removes those links by modifying doc/source/conf.py.
* DOC: update f2py front page and some doc build metadata.Ralf Gommers2017-06-181-3/+3
|
* BUG: KeyboardInterrupt is swallowed all over the placeEric Wieser2017-06-031-3/+3
| | | | Bare except is very rarely the right thing
* MAINT: Update array_ufunc NEP.Pauli Virtanen2017-04-271-0/+1
| | | | | Bring into compliance with current ndarray.__array_ufunc__ implementation and type casting hierarchy.
* DOC: Add SciPy inventory for intersphinx.wrwrwr2016-10-281-0/+1
|
* DOC: Add matplotlib inventory for intersphinx.wrwrwr2016-10-081-1/+4
| | | | | This makes it possible to directly use matplotlib references such as :func:`matplotlib.pyplot.imshow`.
* change all non-code instances of Numpy to NumPyPierre de Buyl2016-09-061-2/+2
| | | | | | | | | Instances remain for NumpyVersion and Numpy.rec.fromarrays that are references to code. Release notes were left unchanged. see issue #7986
* DOC: Extend github source links to line rangesJan Schlüter2015-06-081-2/+2
|
* STY: Giant whitespace cleanup.Charles Harris2013-08-181-2/+2
| | | | Now is as good a time as any with open PR's at a low.
* DOC: use the new scipy-sphinx-theme in the documentationPauli Virtanen2013-07-251-49/+34
|
* DOC: remove module index from reference guide.Ralf Gommers2013-06-041-1/+1
| | | | | It was broken, and after fixing it looked quite useless. Update in conf.py is because `html_use_modindex` is deprecated.
View Lorry Controller Status