usrbinenv python3 jupyter notebook documentation build configuration file sphinxquickstart on mon apr 13 09 51 11 2015 this file is execfiled with the current directory set to its containing dir note that not all possible configuration values are present in this autogenerated file all configuration values have a default values that are commented out serve to show the default 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 documentation root use os path abspath to make it absolute like shown here debug for rtd add repo root to sys path here rootdocssource copy the markdown file here copy the contributing file here debug for post insert on rtd general configuration if your documentation needs a minimal sphinx version state it here needssphinx 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 add any paths that contain templates here relative to this directory the suffixes of source filenames you can specify multiple suffix as a list of string sourcesuffix rst md the encoding of source files sourceencoding utf8sig the master toctree document general information about the project ghissue config the version info for the project you re documenting acts as replacement for version and release also used in various other places throughout the built documents the short x y version the full version including alphabetarc tags the language for content autogenerated by sphinx refer to documentation for a list of supported languages this is also used if you do content translation via gettext catalogs usually you set language from the command line for these cases there are two options for replacing today either you set today to some nonfalse value then it is used today else todayfmt is used as the format for a strftime call todayfmt b d y list of patterns relative to source directory that match files and directories to ignore when looking for source files the rest default role used for this markup text to use for all documents defaultrole none if true will be appended to func etc crossreference text addfunctionparentheses true if true the current module name will be prepended to all description unit titles such as function addmodulenames true if true section and module directives will be shown in the output they are ignored by default shows false the name of the pygments syntax highlighting style to use a list of ignored prefixes for module index sorting modindexcommonprefix if true keep warnings as system message paragraphs in the built documents keepwarnings false if true todo and todolist produce output else they produce nothing options for html output the theme to use for html and html help pages see the documentation for a list of builtin themes theme options are themespecific and customize the look and feel of a theme further for a list of options available for each theme see the documentation output for github to be used in links add any paths that contain custom themes here relative to this directory htmlthemepath the name for this set of sphinx documents if none it defaults to project vrelease documentation htmltitle none a shorter title for the navigation bar default is the same as htmltitle htmlshorttitle none the name of an image file relative to this directory to place at the top of the sidebar 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 htmlfavicon 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 so a file named default css will overwrite the builtin default css note sphinx s make html builder will throw a warning about an unfound static directory do not remove or comment out htmlstaticpath since it is needed to properly generate static in the build directory 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 htmlextrapath if not a last updated on timestamp is inserted at every page bottom using the given strftime format htmllastupdatedfmt b d y if true smartypants will be used to convert quotes and dashes to typographically correct entities htmlusesmartypants true custom sidebar templates maps document names to template names htmlsidebars additional templates that should be rendered to pages maps page names to template names htmladditionalpages if false no module index is generated htmldomainindices true if false no index is generated htmluseindex true if true the index is split into individual pages for each letter htmlsplitindex false if true links to the rest sources are added to the pages htmlshowsourcelink true if true created using sphinx is shown in the html footer default is true htmlshowsphinx true if true c is shown in the html footer default is true htmlshow 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 htmluseopensearch this is the file name suffix for html files e g xhtml htmlfilesuffix none language to be used for generating the html fulltext search index sphinx supports the following languages da de en es fi fr h it ja nl no pt ro r sv tr htmlsearchlanguage en a dictionary with options for the search language support empty by default now only ja uses this config value htmlsearchoptions 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 htmlsearchscorer scorer js output file base name for html help builder this will ensure that we use the correctly set environment for canonical urls old read the docs injections makes it point only to the default version for instance enstable options for latex output grouping the document tree into latex files list of tuples source start file target name title documentclass howto manual or own class the name of an image file relative to this directory to place at the top of the title page latexlogo none for manual documents if this is true then toplevel headings are parts not chapters latexuseparts false if true show page references after internal links latexshowpagerefs false if true show url addresses after external links latexshowurls false documents to append as an appendix to all manuals latexappendices if false no module index is generated latexdomainindices true options for manual page output one entry per manual page list of tuples source start file name description s manual section if true show url addresses after external links manshowurls false options for link checks options for texinfo output grouping the document tree into texinfo files list of tuples source start file target name title dir menu entry description category documents to append as an appendix to all manuals texinfoappendices if false no module index is generated texinfodomainindices true how to display url addresses footnote no or inline texinfoshowurls footnote if true do not generate a detailmenu in the top node s menu texinfonodetailmenu false usr bin env python3 jupyter notebook documentation build configuration file sphinx quickstart on mon apr 13 09 51 11 2015 this file is execfile d with the current directory set to its containing dir note that not all possible configuration values are present in this autogenerated file all configuration values have a default values that are commented out serve to show the default 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 documentation root use os path abspath to make it absolute like shown here debug for rtd add repo root to sys path here root docs source copy the markdown file here copy the contributing file here debug for post insert on rtd general configuration if your documentation needs a minimal sphinx version state it here 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 type ignore noqa add any paths that contain templates here relative to this directory 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 the master toctree document general information about the project noqa ghissue config the version info for the project you re documenting acts as replacement for version and release also used in various other places throughout the built documents noqa the short x y version the full version including alpha beta rc tags the language for content autogenerated by sphinx refer to documentation for a list of supported languages this is also used if you do content translation via gettext catalogs usually you set language from the command line for these cases there are two options for replacing today either you set today to some non false value then it is used today else today_fmt is used as the format for a strftime call today_fmt b d y list of patterns relative to source directory that match files and directories to ignore when looking for source files the rest default role used for this markup text to use for all documents default_role none if true will be appended to func etc cross reference text 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 if true section and module directives will be shown in the output they are ignored by default show_s false the name of the pygments syntax highlighting style to use a list of ignored prefixes for module index sorting modindex_common_prefix if true keep warnings as system message paragraphs in the built documents keep_warnings false if true todo and todolist produce output else they produce nothing options for html output the theme to use for html and html help pages see the documentation for a list of builtin themes 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 output for github to be used in links username repo name version path in the checkout to the docs root add any paths that contain custom themes here relative to this directory html_theme_path the name for this set of sphinx documents if none it defaults to project v release documentation html_title none a shorter title for the navigation bar default is the same as html_title html_short_title none the name of an image file relative to this directory to place at the top of the sidebar 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 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 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 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 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 if true smartypants will be used to convert quotes and dashes to typographically correct entities html_use_smartypants true custom sidebar templates maps document names to template names html_sidebars additional templates that should be rendered to pages maps page names to template names html_additional_pages if false no module index is generated html_domain_indices true if false no index is generated html_use_index true if true the index is split into individual pages for each letter html_split_index false if true links to the rest sources are added to the pages html_show_sourcelink true if true created using sphinx is shown in the html footer default is true html_show_sphinx true if true c is shown in the html footer default is true html_show_ 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 this is the file name suffix for html files e g xhtml 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 a dictionary with options for the search language support empty by default now only ja uses this config value 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 output file base name for html help builder this will ensure that we use the correctly set environment for canonical urls old read the docs injections makes it point only to the default version for instance en stable options for latex output grouping the document tree into latex files list of tuples source start file target name title documentclass howto manual or own class the name of an image file relative to this directory to place at the top of the title page latex_logo none for manual documents if this is true then toplevel headings are parts not chapters latex_use_parts false if true show page references after internal links latex_show_pagerefs false if true show url addresses after external links latex_show_urls false documents to append as an appendix to all manuals latex_appendices if false no module index is generated latex_domain_indices true options for manual page output one entry per manual page list of tuples source start file name description s manual section if true show url addresses after external links man_show_urls false options for link checks options for texinfo output grouping the document tree into texinfo files list of tuples source start file target name title dir menu entry description category documents to append as an appendix to all manuals texinfo_appendices if false no module index is generated texinfo_domain_indices true how to display url addresses footnote no or inline texinfo_show_urls footnote if true do not generate a detailmenu in the top node s menu texinfo_no_detailmenu false
import logging
import os
import shutil
import sys

logger = logging.getLogger(__name__)
logging.basicConfig()


logger.info("DEBUG:: sys.path")
logger.info("================")
for item in sys.path:
    logger.info(item)



here = os.path.abspath(os.path.dirname(__file__))
repo_root = os.path.dirname(os.path.dirname(here))
sys.path.insert(0, repo_root)


shutil.copy(os.path.join(repo_root, "CHANGELOG.md"), os.path.join(here, "changelog.md"))


shutil.copy(os.path.join(repo_root, "CONTRIBUTING.md"), os.path.join(here, "contributing.md"))

logger.info("repo_root")
logger.info("=====================")
logger.info(repo_root)


logger.info("DEBUG:: Post insert to sys.path")
logger.info("===============================")
for item in sys.path:
    logger.info(item)


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",
]

try:
    import enchant  

    extensions += ["sphinxcontrib.spelling"]
except ImportError:
    pass

myst_enable_extensions = ["html_image"]
myst_update_mathjax = False


templates_path = ["_templates"]


master_doc = "index"


project = "Jupyter Notebook"
copyright = "2015, Jupyter Team, https://jupyter.org"  
author = "The Jupyter Team"


github_project_url = "https://github.com/jupyter/notebook"


_version_py = os.path.join(here, "../../notebook/_version.py")
version_ns = {}
exec(compile(open(_version_py).read(), _version_py, "exec"), version_ns)  

version = "%i.%i" % version_ns["version_info"][:2]

release = version_ns["__version__"]


language = "en"


exclude_patterns = [
    "examples/Notebook/.ipynb_checkpoints",
    "examples/Notebook/nbpackage/*.ipynb",
    "examples/Notebook/nbpackage/nbs/*.ipynb",
]


pygments_style = "sphinx"


todo_include_todos = False


html_theme = "pydata_sphinx_theme"


html_theme_options = {
    "icon_links": [
        {
            "name": "jupyter.org",
            "url": "https://jupyter.org",
            "icon": "_static/jupyter_logo.svg",
            "type": "local",
        },
        {
            "name": "GitHub",
            "url": "https://github.com/jupyter/notebook",
            "icon": "fab fa-github-square",
        },
        {
            "name": "Discourse",
            "url": "https://discourse.jupyter.org/c/notebook/31",
            "icon": "fab fa-discourse",
        },
        {
            "name": "Gitter",
            "url": "https://gitter.im/jupyter/jupyter",
            "icon": "fab fa-gitter",
        },
    ],
    "logo": {
        "alt_text": "Jupyter",
        "image_light": "_static/logo-rectangle.svg",
        "image_dark": "_static/logo-rectangle-dark.svg",
    },
    "use_edit_page_button": True,
    "navigation_with_keys": False,
}


html_context = {
    "github_user": "jupyter",  
    "github_repo": "notebook",  
    "github_version": "main",  
    "doc_path": "docs/source/",  
}



html_logo = "examples/images/jupyter_logo.png"



html_static_path = ["_static"]



htmlhelp_basename = "JupyterNotebookdoc"




html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/")



latex_elements = {}




latex_documents = [
    (
        master_doc,
        "JupyterNotebook.tex",
        "Jupyter Notebook Documentation",
        "https://jupyter.org",
        "manual",
    ),
]


























man_pages = [(master_doc, "jupyternotebook", "Jupyter Notebook Documentation", [author], 1)]







linkcheck_ignore = [r"http://127\.0\.0\.1/*"]







texinfo_documents = [
    (
        master_doc,
        "JupyterNotebook",
        "Jupyter Notebook Documentation",
        author,
        "JupyterNotebook",
        "One line description of project.",
        "Miscellaneous",
    ),
]













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),
}

spelling_lang = "en_US"
spelling_word_list_filename = "spelling_wordlist.txt"