@ -12,9 +12,9 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
import shutil
import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@ -51,43 +51,43 @@ for item in sys.path:
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
' sphinx.ext.autodoc ' ,
' sphinx.ext.doctest ' ,
' sphinx.ext.intersphinx ' ,
' sphinx.ext.autosummary ' ,
' sphinx.ext.mathjax ' ,
' IPython.sphinxext.ipython_console_highlighting ' ,
' nbsphinx ' ,
' sphinxcontrib_github_alt ' ,
' myst_parser '
" sphinx.ext.autodoc " ,
" sphinx.ext.doctest " ,
" sphinx.ext.intersphinx " ,
" sphinx.ext.autosummary " ,
" sphinx.ext.mathjax " ,
" IPython.sphinxext.ipython_console_highlighting " ,
" nbsphinx " ,
" sphinxcontrib_github_alt " ,
" myst_parser " ,
]
myst_enable_extensions = [ " html_image " ]
myst_update_mathjax = False
# Add any paths that contain templates here, relative to this directory.
templates_path = [ ' _templates ' ]
templates_path = [ " _templates " ]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = ' index '
master_doc = " index "
# General information about the project.
project = ' Jupyter Notebook '
copyright = ' 2015, Jupyter Team, https://jupyter.org '
author = ' The Jupyter Team '
project = " Jupyter Notebook "
copyright = " 2015, Jupyter Team, https://jupyter.org "
author = " The Jupyter Team "
# ghissue config
github_project_url = " https://github.com/jupyter/notebook "
@ -96,13 +96,13 @@ github_project_url = "https://github.com/jupyter/notebook"
# |version| and |release|, also used in various other places throughout the
# built documents.
#
_version_py = ' ../../notebook/_version.py '
_version_py = " ../../notebook/_version.py "
version_ns = { }
exec ( compile ( open ( _version_py ) . read ( ) , _version_py , ' exec ' ) , version_ns )
exec ( compile ( open ( _version_py ) . read ( ) , _version_py , " exec " ) , version_ns )
# The short X.Y version.
version = ' %i . %i ' % version_ns [ ' version_info ' ] [ : 2 ]
version = " %i . %i " % version_ns [ " version_info " ] [ : 2 ]
# The full version, including alpha/beta/rc tags.
release = version_ns [ ' __version__ ' ]
release = version_ns [ " __version__ " ]
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -113,37 +113,41 @@ language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [ ' examples/Notebook/.ipynb_checkpoints ' , ' examples/Notebook/nbpackage/*.ipynb ' , ' examples/Notebook/nbpackage/nbs/*.ipynb ' ]
exclude_patterns = [
" examples/Notebook/.ipynb_checkpoints " ,
" examples/Notebook/nbpackage/*.ipynb " ,
" examples/Notebook/nbpackage/nbs/*.ipynb " ,
]
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = ' sphinx '
pygments_style = " sphinx "
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@ -158,17 +162,17 @@ html_theme = "pydata_sphinx_theme"
# 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 = {}
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@ -177,7 +181,7 @@ html_logo = "examples/images/jupyter_logo.png"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
# html_favicon = None
# 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,
@ -185,134 +189,131 @@ html_logo = "examples/images/jupyter_logo.png"
# NOTE: Sphinx's 'make html' builder will throw a warning about an unfound
# _static directory. Do not remove or comment out html_static_path
# since it is needed to properly generate _static in the build directory
html_static_path = [ ' _static ' ]
html_static_path = [ " _static " ]
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# html_additional_pages = {}
# If false, no module index is generated.
# html_domain_indices = True
# html_domain_indices = True
# If false, no index is generated.
# html_use_index = True
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
# html_search_language = 'en'
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
# html_search_options = {'type': 'default'}
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
# html_search_scorer = 'scorer.js'
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = ' JupyterNotebookdoc '
htmlhelp_basename = " JupyterNotebookdoc "
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Latex figure (float) alignment
#'figure_align': 'htbp',
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Latex figure (float) alignment
#'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
( master_doc , ' JupyterNotebook.tex ' , ' Jupyter Notebook Documentation ' ,
' https://jupyter.org ' , ' manual ' ) ,
(
master_doc ,
" JupyterNotebook.tex " ,
" Jupyter Notebook Documentation " ,
" https://jupyter.org " ,
" manual " ,
) ,
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# latex_use_parts = False
# If true, show page references after internal links.
# latex_show_pagerefs = False
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
( master_doc , ' jupyternotebook ' , ' Jupyter Notebook Documentation ' ,
[ author ] , 1 )
]
man_pages = [ ( master_doc , " jupyternotebook " , " Jupyter Notebook Documentation " , [ author ] , 1 ) ]
# If true, show URL addresses after external links.
# man_show_urls = False
# man_show_urls = False
# -- Options for link checks ----------------------------------------------
linkcheck_ignore = [
' http://127 \ .0 \ .0 \ .1/* '
]
linkcheck_ignore = [ " http://127 \ .0 \ .0 \ .1/* " ]
# -- Options for Texinfo output -------------------------------------------
@ -321,29 +322,35 @@ linkcheck_ignore = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
( master_doc , ' JupyterNotebook ' , ' Jupyter Notebook Documentation ' ,
author , ' JupyterNotebook ' , ' One line description of project. ' ,
' Miscellaneous ' ) ,
(
master_doc ,
" JupyterNotebook " ,
" Jupyter Notebook Documentation " ,
author ,
" JupyterNotebook " ,
" One line description of project. " ,
" Miscellaneous " ,
) ,
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
# texinfo_no_detailmenu = False
intersphinx_mapping = {
' ipython ' : ( ' https://ipython.readthedocs.io/en/stable/ ' , None ) ,
' nbconvert ' : ( ' https://nbconvert.readthedocs.io/en/latest/ ' , None ) ,
' nbformat ' : ( ' https://nbformat.readthedocs.io/en/latest/ ' , None ) ,
' jupyter ' : ( ' https://jupyter.readthedocs.io/en/latest/ ' , None ) ,
" ipython " : ( " https://ipython.readthedocs.io/en/stable/ " , None ) ,
" nbconvert " : ( " https://nbconvert.readthedocs.io/en/latest/ " , None ) ,
" nbformat " : ( " https://nbformat.readthedocs.io/en/latest/ " , None ) ,
" jupyter " : ( " https://jupyter.readthedocs.io/en/latest/ " , None ) ,
}
spelling_lang = ' en_US '
spelling_word_list_filename = ' spelling_wordlist.txt '
spelling_lang = " en_US "
spelling_word_list_filename = " spelling_wordlist.txt "
Steven Silvester
4 years ago
committed by
GitHub