diff options
author | Ralf Gommers <ralf.gommers@gmail.com> | 2020-08-31 16:18:35 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-08-31 16:18:35 +0100 |
commit | 60f9c616aa12800e27baef1db0f964cd9da6623f (patch) | |
tree | 1dbdda1b23398217f237e3a6739d6007fee25d82 /doc/neps | |
parent | 54811204a63c2606e89c4f053c4b9a7215207079 (diff) | |
parent | 48de200a2ed9b6e5d6866f06dec07c90d381f859 (diff) | |
download | numpy-60f9c616aa12800e27baef1db0f964cd9da6623f.tar.gz |
Merge pull request #17074 from mattip/pydata-sphinx-theme
DOC: use the pydata_sphinx_theme
Diffstat (limited to 'doc/neps')
-rw-r--r-- | doc/neps/conf.py | 78 | ||||
-rw-r--r-- | doc/neps/content.rst | 25 |
2 files changed, 40 insertions, 63 deletions
diff --git a/doc/neps/conf.py b/doc/neps/conf.py index 6837b12bd..f01ee8a51 100644 --- a/doc/neps/conf.py +++ b/doc/neps/conf.py @@ -45,7 +45,7 @@ templates_path = ['../source/_templates/'] source_suffix = '.rst' # The master toctree document. -master_doc = 'index' +master_doc = 'content' # General information about the project. project = u'NumPy Enhancement Proposals' @@ -82,69 +82,21 @@ todo_include_todos = False ## -- Options for HTML output ---------------------------------------------- # -## The theme to use for HTML and HTML Help pages. See the documentation for -## a list of builtin themes. -## -#html_theme = 'alabaster' -# -## Theme options are theme-specific and customize the look and feel of a theme -## further. For a list of options available for each theme, see the -## documentation. -## -## html_theme_options = {} -# -## Add any paths that contain custom static files (such as style sheets) here, -## relative to this directory. They are copied after the builtin static files, -## so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['_static'] -# -## Custom sidebar templates, must be a dictionary that maps document names -## to template names. -## -## This is required for the alabaster theme -## refs: https://alabaster.readthedocs.io/en/latest/installation.html#sidebars -#html_sidebars = { -# '**': [ -# 'relations.html', # needs 'show_related': True theme option to display -# 'searchbox.html', -# ] -#} - -## ----------------------------------------------------------------------------- -# HTML output -# ----------------------------------------------------------------------------- -themedir = os.path.join(os.pardir, 'scipy-sphinx-theme', '_theme') -if not os.path.isdir(themedir): - raise RuntimeError("Get the scipy-sphinx-theme first, " - "via git submodule init && git submodule update") - -html_theme = 'scipy' -html_theme_path = [themedir] - -#if 'scipyorg' in tags: -if True: - # Build for the scipy.org website - html_theme_options = { - "edit_link": True, - "sidebar": "right", - "scipy_org_logo": True, - "rootlinks": [("https://scipy.org/", "Scipy.org"), - ("https://docs.scipy.org/", "Docs")] - } -else: - # Default build - html_theme_options = { - "edit_link": False, - "sidebar": "left", - "scipy_org_logo": False, - "rootlinks": [] - } - html_sidebars = {'index': 'indexsidebar.html'} - -#html_additional_pages = { -# 'index': 'indexcontent.html', -#} +html_theme = 'pydata_sphinx_theme' + +html_logo = '../source/_static/numpylogo.svg' + +html_theme_options = { + "github_url": "https://github.com/numpy/numpy", + "twitter_url": "https://twitter.com/numpy_team", + "external_links": [ + {"name": "Wishlist", + "url": "https://github.com/numpy/numpy/issues?q=is%3Aopen+is%3Aissue+label%3A%2223+-+Wish+List%22", + }, + ], + "show_prev_next": False, +} html_title = "%s" % (project) html_static_path = ['../source/_static'] diff --git a/doc/neps/content.rst b/doc/neps/content.rst new file mode 100644 index 000000000..f5d8347c4 --- /dev/null +++ b/doc/neps/content.rst @@ -0,0 +1,25 @@ +===================================== +Roadmap & NumPy Enhancement Proposals +===================================== + +This page provides an overview of development priorities for NumPy. +Specifically, it contains a roadmap with a higher-level overview, as +well as NumPy Enhancement Proposals (NEPs)—suggested changes +to the library—in various stages of discussion or completion (see `NEP +0 <nep-0000>`__). + +Roadmap +------- +.. toctree:: + :maxdepth: 1 + + Index <index> + The Scope of NumPy <scope> + Current roadmap <roadmap> + Wishlist (opens new window) |wishlist_link| + +.. |wishlist_link| raw:: html + + <a href="https://github.com/numpy/numpy/issues?q=is%3Aopen+is%3Aissue+label%3A%2223+-+Wish+List%22" target=" blank">WishList</a> + + |