summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* MAINT: Remove encoding declarations: # -*- coding: utf-8 -*-Dimitri Papadopoulos2021-10-061-1/+0
| | | | In Python 3, the default source file encoding is UTF-8.
* DOC: skip generating c/c++ doc from comment blocks when Doxygen or Breathe ↵Sayed Adel2021-08-311-1/+11
| | | | isn't available.
* DOC: Add support for documenting C/C++ via Doxygen & BreatheSayed Adel2021-08-301-0/+9
|
* DOC: Reorganized the documentation contribution docs (#19645)Mukulika2021-08-121-0/+1
| | | | | | | | * DOC: Reorganized documentation contribution docs 1. Removed Documentation conventions page 2. Merged A guide to NumPy documentation into How to contribute to NumPy documentation 3. Moved Building NumPy reference and docs to Development section 4. Removed the Documentation index stub
* DOC: Additional ideas related to numpy-tutorials integration (#19422)Ross Barnowski2021-07-191-0/+3
| | | | | | | | | | | * Add navbar link to numpy-tutorials. * External links instead of tutorials stub. * Update tutorial-svd link to intersphinx. * Point tutorials to features, not applications. * Fix linter
* Merge pull request #19290 from rossbar/doc/unpin-pydata-sphinx-themeCharles Harris2021-06-231-0/+1
|\ | | | | DOC: Unpin pydata sphinx theme and update config to avoid long doc build times
| * Unpin pydata sphinx theme and update config.Ross Barnowski2021-06-211-0/+1
| | | | | | | | | | | | | | | | | | | | As of v0.6, the pydata-sphinx-theme has a collapsible navigation feature for the sidebar that significantly increases the build time and html file size for the docs. We had originally pinned to 0.5.2 to avoid this, but the feature is now configurable with the collapse_navigation=True value. Remove the upper-bound pinning the theme and instead use the configuration option to keep doc build times reasonable.
* | DOC: Do not generate source URLs for re-exported objectsBas van Beek2021-06-221-0/+5
|/ | | | Ignore re-exports as their source files are not within the numpy repo.
* Add intersphinx link to numpy-tutorials.Ross Barnowski2021-06-081-0/+1
|
* MAINT: replace imgmath with mathjax for docs (#19036)Melissa Weber Mendonça2021-05-271-3/+3
|
* DOC: change copyright SciPy to NumPylbogula2021-05-091-1/+1
| | | | Co-authored-by: Lima Tango <19208585+lima-tango@users.noreply.github.com>
* DOC: Add favicon (#18841)Tania Allard2021-04-231-0/+2
|
* DOC: Document newer pytest conventionsEric Larson2021-04-161-0/+1
|
* Update navbar linked page back to indexleonarduschen2021-03-121-0/+1
|
* MAINT: Update master to main after branch rename (gh-18544)Stefan van der Walt2021-03-041-1/+2
| | | | | | | | | | | | | | | | | | | | | | | * Upload docs to main branch of neps/devdocs * Update `master` to `main` to be consistent with current state of renaming * Remove badges from README * Replace remaining instances of `master` with `main` * Add back logo * Fix CircleCI branch checks * Fix GA branch name * master->main in issue templates. * master->main for 2 links to numpy archive. * Change master to main in NEP 23 Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* 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
|
View Lorry Controller Status