conf.py

# -*- coding: utf-8 -*-
#
# 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.

# 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '2.0'

# If true, figures, tables and code-blocks are automatically numbered if they
# have a caption. For now, it works only with the HTML builder.
numfig = True

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
    # Standard extensions
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
    'sphinx.ext.intersphinx',
    'sphinx.ext.extlinks',
    # External extensions
    #'sphinxcontrib.email',      # Mail obfuscation (incompatible w/ RTFD)
    'nbsphinx',                 # Support for Ipython Notebooks
]

# Intersphinx configuration
intersphinx_mapping = {
    'python': ('https://docs.python.org/3/', None),
    'numpy': ('https://numpy.org/doc/stable/', None),
    'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
    'matplotlib': ('https://matplotlib.org/', None),
    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
    'xarray': ('https://xarray.pydata.org/en/stable/', None),
    'astropy': ('https://docs.astropy.org/en/stable/', None),
}

# Extlinks configuration
extlinks = {
    'pypi': ('https://pypi.org/project/%s', ''),     # Pypi
    'rtfd': ('https://%s.readthedocs.io/', ''),      # readthedocs.io
    'ads': ('https://ui.adsabs.harvard.edu/abs/%s/abstract', ''), # ADS
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.txt'

# The encoding of source files.
source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Analyse scientifique avec Python'
author = 'Yannick Copin <y.copin(at)ipnl.in2p3.fr>'

# 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.
version = u'Informatique Python'
# The full version, including alpha/beta/rc tags.
release = u'Novembre 2020'

copyright = ', '.join((release, author))

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = 'fr'

# 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'
today_fmt = '%d/%m/%y, %H:%M'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'requirements.txt', '**.ipynb_checkpoints']

# The reST default role (used for this markup: `text`) to use for all documents.
default_role = 'literal'

# 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, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = True

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# # Make spaces visibles
# def setup(sphinx):
#     from pygments.lexers import PythonLexer
#     from pygments.filters import VisibleWhitespaceFilter
#     myLexer = PythonLexer()
#     myLexer.add_filter(VisibleWhitespaceFilter(spaces=True))
#     sphinx.add_lexer('python', myLexer);

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# A string of reStructuredText that will be included at the end of
# every source file that is read.
rst_epilog = u""

# A string of reStructuredText that will be included at the start of
# every source file that is read.
# rst_prolog = u"""
# .. Warning::
#
#    Conversion to Python3 in progress!!!
# """
rst_prolog = u""

nbsphinx_prolog = r"""
{% set docname = env.doc2path(env.docname, base=None) %}
.. raw:: latex

   \nbsphinxstartnotebook{\scriptsize\noindent\strut
   \textcolor{gray}{The following section was generated from
   \sphinxcode{\sphinxupquote{\strut {{ docname | escape_latex }}}} \dotfill}}
"""

nbsphinx_epilog = r"""
{% set docname = env.doc2path(env.docname, base=None) %}
.. only:: html

   .. role:: raw-html(raw)
      :format: html

   .. nbinfo::

      This page was generated from `{{ docname }}`.

.. raw:: latex

   \nbsphinxstopnotebook{\scriptsize\noindent\strut
   \textcolor{gray}{\dotfill\ \sphinxcode{\sphinxupquote{\strut
   {{ docname | escape_latex }}}} ends here.}}
"""

mathjax_config = {
    'TeX': {'equationNumbers': {'autoNumber': 'AMS', 'useLabelIds': True}},
}

# Additional files needed for generating LaTeX/PDF output:
latex_additional_files = ['references.bib']

# Support for notebook formats other than .ipynb
nbsphinx_custom_formats = {
    '.pct.py': ['jupytext.reads', {'fmt': 'py:percent'}],
}


# -- 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 = 'default'
# http://sphinx.pocoo.org/theming.html
# default, sphinxdoc, scrolls, agogo, traditional, nature, haiku
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.

# Alabaster: see http://alabaster.readthedocs.io/en/latest/customization.html
html_theme_options = {
    'page_width': '75%',
    'sidebar_width': '25%',
    #'fixed_sidebar': True,
    'sidebar_includehidden': False,
    'description': u"Une introduction à Python utilisé dans un contexte scientifique."
}

# 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.
html_logo = '_static/scipy2.png'  # Ne pas utiliser avec thème agogo

# 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".
html_static_path = ['_static']

# 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. **DEPRECATED*
#html_use_smartypants = True
smartquotes = 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) Copyright ..." is shown in the HTML footer. Default is 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 = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

html_add_permalinks = u'🔗' # ☜☚¶⚐⚑, 🔗 = link symbol

# Output file base name for HTML help builder.
htmlhelp_basename = 'AnalyseScientifiquePython'


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    'papersize': 'a4paper',

    # The font size ('10pt', '11pt' or '12pt').
    'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    'preamble': r"""
    \usepackage{lmodern}                % heavier typewriter font
    \DeclareUnicodeCharacter{2605}{*}   % star
    \DeclareUnicodeCharacter{9760}{*}   % skull
    """,
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
  ('index', 'analyseScientifiquePython.tex',
   u'Analyse scientifique avec Python',
   u'Yannick Copin', 'manual'),
]

# 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 linkcheck --------------------------------------------------

# Ignore intersphinx links
linkcheck_ignore = [
    r'https://docs.python.org/3/reference/',              # Python reference
    r'https://docs.python.org/3/library/',                # Python library
    r'https://numpy.org/doc/stable/reference/generated/', # Numpy doc
    r'https://pandas.pydata.org/pandas-doc/stable/reference/generated/', # Pandas
]