conf.py

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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.
#
from os.path import dirname, abspath, normpath, join
import sys

sys.path.insert(0, normpath(abspath(join(dirname(__file__), "../pyleecan/"))))
from datetime import date

# At top on conf.py
from sphinx_markdown_parser.transform import AutoStructify


# -- Project information -----------------------------------------------------

project = "pyleecan"
copyright = u"%s Green Forge Coop (GFC). Last update on %s" % (
    date.today().year,
    date.today(),
)
author = "Author"

# The short X.Y version
version = ""
# The full version, including alpha/beta/rc tags
release = ""


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

add_module_names = False
extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.viewcode",
    "sphinx.ext.todo",
    "sphinx.ext.napoleon",
    "sphinx.ext.extlinks",
    "sphinx.ext.intersphinx",
    "sphinx.ext.autosectionlabel",
    "nbsphinx",
    #"sphinxcontrib.googleanalytics",
]
autodoc_member_order = "bysource"
autosectionlabel_prefix_document = True

# Defning Google analytics_id
#googleanalytics_id = "UA-161753839-3"
#googleanalytics_enabled = True

# Allow errorw in the code when generating the website
nbsphinx_allow_errors = True
nbsphinx_execute = "never"
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = {
    ".rst": "restructuredtext",
    ".md": "markdown",
}


# The master toctree document.
master_doc = "documentation"

# 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.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
    "_build",
    "Thumbs.db",
    ".DS_Store",
    "pyleecan.GUI.rst",
    "pyleecan.run_GUI.rst",
]

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


# -- 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 = "sphinxdoc"

# 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.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
html_sidebars = {
    "**": [
        "relations.html",
        "searchbox.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "index": [
        "sitenav.html",
        "localtoc.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "code.of.conduct": [
        "sitenav.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "license": ["sitenav.html", "newsletter.html", "git_info.html", "sourcelink.html"],
    "development": [
        "contribution.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "project.organization": [
        "contribution.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "code.contribution": [
        "contribution.html",
        "contributionToCode.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "object.organization": [
        "contribution.html",
        "contributionToCode.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "machine.object": [
        "contribution.html",
        "contributionToCode.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "coding.convention": [
        "contribution.html",
        "contributionToCode.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "class.generation": [
        "contribution.html",
        "contributionToCode.html",
        "localtoc.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "generation.process": [
        "contribution.html",
        "contributionToCode.html",
        "localtoc.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "test.contribution": [
        "contribution.html",
        "localtoc.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "output.object": [
        "contribution.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "doc.contribution": [
        "contribution.html",
        "localtoc.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "objectives&features": [
        "sitenav.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "tutorials": [
        "localtoc.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "contact": ["newsletter.html", "git_info.html", "sourcelink.html"],
    "prerequisite": [
        "localtoc.html",
        "newsletter.html",
        "git_info.html",
        "sourcelink.html",
    ],
    "01_tuto_Machine": ["localtoc.html", "newsletter.html", "git_info.html"],
    "02_tuto_Simulation_FEMM": ["localtoc.html", "newsletter.html", "git_info.html"],
    "03_tuto_Plots": ["localtoc.html", "newsletter.html", "git_info.html"],
    "09_tuto_Optimization": ["localtoc.html", "newsletter.html", "git_info.html"],
    "tuto.add.slot": ["localtoc.html", "newsletter.html", "git_info.html"],
    "webinar_1": ["newsletter.html", "git_info.html", "sourcelink.html"],
    "webinar_2": ["newsletter.html", "git_info.html", "sourcelink.html"],
}

html_title = "PYthon Library for Electrical Engineering Computational ANalysis"
# -- Options for HTMLHelp output ---------------------------------------------
html_favicon = "_static/favicon.png"
# Output file base name for HTML help builder.
htmlhelp_basename = "pyleecandoc"


# -- 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',
}

# 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, "pyleecan.tex", "pyleecan Documentation", "Author", "manual"),
]


# -- 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, "pyleecan", "pyleecan Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (
        master_doc,
        "pyleecan",
        "pyleecan Documentation",
        author,
        "pyleecan",
        "One line description of project.",
        "Miscellaneous",
    ),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]


# -- Extension configuration -------------------------------------------------

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

# for MarkdownParser
from sphinx_markdown_parser.parser import MarkdownParser


def setup(app):
    app.add_source_suffix(".md", "markdown")
    app.add_source_parser(MarkdownParser)
    app.add_config_value(
        "markdown_parser_config",
        {
            "auto_toc_tree_section": "Content",
            "enable_auto_doc_ref": True,
            "enable_auto_toc_tree": True,
            "enable_eval_rst": True,
            "extensions": [
                "extra",
                "nl2br",
                "sane_lists",
                "smarty",
                "toc",
                "wikilinks",
                "pymdownx.arithmatex",
            ],
        },
        True,
    )
    # in setup function after configuration of the parser
    app.add_transform(AutoStructify)