From 6c8aa42ce668aa57ddc3347df35998fc32e7240a Mon Sep 17 00:00:00 2001 From: takanori-pskq Date: Fri, 6 Nov 2020 01:40:02 +0000 Subject: DOC: Fix for buildling with sphinx 3 --- doc/source/conf.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index 381a01612..e76f60063 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -4,7 +4,7 @@ import re 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 @@ -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 # ----------------------------------------------------------------------------- -- cgit v1.2.1 From a1a0b6acc1ea5d6fd84443e071f62c874b927f99 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Fri, 5 Feb 2021 17:46:16 +0100 Subject: DOC: remove pygments_style from conf.py --- doc/source/conf.py | 3 --- 1 file changed, 3 deletions(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index e76f60063..e363a8d5e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -138,9 +138,6 @@ add_function_parentheses = False # output. They are ignored by default. #show_authors = False -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - def setup(app): # add a config value for `ifconfig` directives app.add_config_value('python_version_major', str(sys.version_info.major), 'env') -- cgit v1.2.1 From 62b82961e12cc13379fb67f03c71062f94285cd1 Mon Sep 17 00:00:00 2001 From: Aerysv <53720019+Aerysv@users.noreply.github.com> Date: Sat, 6 Feb 2021 23:14:20 +0100 Subject: DOC: Change license date 2020 -> 2021 (gh-18346) A very small contribution to update the license date from 2020 to 2021 :) --- doc/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index e363a8d5e..eff5a90f1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -98,7 +98,7 @@ master_doc = 'contents' # General substitutions. project = 'NumPy' -copyright = '2008-2020, The SciPy community' +copyright = '2008-2021, The SciPy community' # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. -- cgit v1.2.1 From 726a7eb0997a87c664876ac316f037b64c9b8805 Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Tue, 16 Feb 2021 15:28:33 -0800 Subject: DOC: point intersphinx to matplotlib/stable... matplotlib canonical docs are now https://matplotlib.org/stable --- doc/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index eff5a90f1..238f8588a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -285,7 +285,7 @@ intersphinx_mapping = { 'neps': ('https://numpy.org/neps', None), 'python': ('https://docs.python.org/dev', None), 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None), - 'matplotlib': ('https://matplotlib.org', None), + 'matplotlib': ('https://matplotlib.org/stable', None), 'imageio': ('https://imageio.readthedocs.io/en/stable', None), 'skimage': ('https://scikit-image.org/docs/stable', None), 'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None), -- cgit v1.2.1 From 678919107f29a1da946d2c2ca00d712b830a5753 Mon Sep 17 00:00:00 2001 From: Ross Barnowski Date: Fri, 26 Feb 2021 13:00:14 -0800 Subject: DOC: mv meta landing page to index.rst. 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/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index 238f8588a..7eb96eb22 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -94,7 +94,7 @@ templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' -master_doc = 'contents' +master_doc = 'index' # General substitutions. project = 'NumPy' -- cgit v1.2.1 From 954605ec08ad833899ffb956395f2d70f8eea2df Mon Sep 17 00:00:00 2001 From: Stefan van der Walt Date: Thu, 4 Mar 2021 07:11:41 -0800 Subject: MAINT: Update master to main after branch rename (gh-18544) * 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 --- doc/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index 7eb96eb22..dcf60ada9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -94,6 +94,7 @@ templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' +# Will change to `root_doc` in Sphinx 4 master_doc = 'index' # General substitutions. @@ -442,7 +443,7 @@ def linkcode_resolve(domain, info): linespec = "" if 'dev' in numpy.__version__: - return "https://github.com/numpy/numpy/blob/master/numpy/%s%s" % ( + return "https://github.com/numpy/numpy/blob/main/numpy/%s%s" % ( fn, linespec) else: return "https://github.com/numpy/numpy/blob/v%s/numpy/%s%s" % ( -- cgit v1.2.1 From 54dcb5cf1290098cc7a2a11cf3661c2875d6ac37 Mon Sep 17 00:00:00 2001 From: leonarduschen Date: Mon, 26 Oct 2020 01:57:26 +0800 Subject: Update navbar linked page back to index --- doc/source/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index dcf60ada9..95865c024 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -161,6 +161,7 @@ html_theme = 'pydata_sphinx_theme' html_logo = '_static/numpylogo.svg' html_theme_options = { + "logo_link": "index", "github_url": "https://github.com/numpy/numpy", "twitter_url": "https://twitter.com/numpy_team", } -- cgit v1.2.1 From 065de62261cb41dc02d4483b7b5565e929e8c653 Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Fri, 16 Apr 2021 08:09:18 -0400 Subject: DOC: Document newer pytest conventions --- doc/source/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index 95865c024..fdb9f926d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -292,6 +292,7 @@ intersphinx_mapping = { 'skimage': ('https://scikit-image.org/docs/stable', None), 'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None), 'scipy-lecture-notes': ('https://scipy-lectures.org', None), + 'pytest': ('https://docs.pytest.org/en/stable', None), } -- cgit v1.2.1 From 2946a212a456cc087c9baca090ed691aecaadfc9 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Fri, 23 Apr 2021 13:06:23 +0100 Subject: DOC: Add favicon (#18841) --- doc/source/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index fdb9f926d..4b60800d2 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -160,6 +160,8 @@ html_theme = 'pydata_sphinx_theme' html_logo = '_static/numpylogo.svg' +html_favicon = '_static/favicon/favicon.ico' + html_theme_options = { "logo_link": "index", "github_url": "https://github.com/numpy/numpy", -- cgit v1.2.1 From eb231979b90cfe7f434bd598aefe4196df74b32e Mon Sep 17 00:00:00 2001 From: lbogula Date: Sun, 9 May 2021 14:37:25 +0000 Subject: DOC: change copyright SciPy to NumPy Co-authored-by: Lima Tango <19208585+lima-tango@users.noreply.github.com> --- doc/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index 4b60800d2..bf2fbdce9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -99,7 +99,7 @@ master_doc = 'index' # General substitutions. project = 'NumPy' -copyright = '2008-2021, The SciPy community' +copyright = '2008-2021, The NumPy community' # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. -- cgit v1.2.1 From 89da72353f5e282a36a8e9ad9012400dbe452ced Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Thu, 27 May 2021 06:52:05 -0300 Subject: MAINT: replace imgmath with mathjax for docs (#19036) --- doc/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index bf2fbdce9..5ba7f70b8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -83,11 +83,9 @@ extensions = [ 'matplotlib.sphinxext.plot_directive', 'IPython.sphinxext.ipython_console_highlighting', 'IPython.sphinxext.ipython_directive', - 'sphinx.ext.imgmath', + 'sphinx.ext.mathjax', ] -imgmath_image_format = 'svg' - # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -188,6 +186,8 @@ if 'sphinx.ext.pngmath' in extensions: pngmath_use_preview = True pngmath_dvipng_args = ['-gamma', '1.5', '-D', '96', '-bg', 'Transparent'] +mathjax_path = "scipy-mathjax/MathJax.js?config=scipy-mathjax" + plot_html_show_formats = False plot_html_show_source_link = False -- cgit v1.2.1 From 683a37a03f24f7b090950a40d472b199834cca22 Mon Sep 17 00:00:00 2001 From: Ross Barnowski Date: Tue, 8 Jun 2021 12:00:09 +0300 Subject: Add intersphinx link to numpy-tutorials. --- doc/source/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/source/conf.py') diff --git a/doc/source/conf.py b/doc/source/conf.py index 5ba7f70b8..a49074922 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -295,6 +295,7 @@ intersphinx_mapping = { 'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None), 'scipy-lecture-notes': ('https://scipy-lectures.org', None), 'pytest': ('https://docs.pytest.org/en/stable', None), + 'numpy-tutorials': ('https://numpy.org/numpy-tutorials', None), } -- cgit v1.2.1