import os


class DocStub:
    __version__ = "0.0.0"
    __name__ = "Unknown"


try:
    import bandersnatch as doc_module
except ImportError:
    doc_module = DocStub()


extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.intersphinx",
    "sphinx.ext.ifconfig",
    "sphinx.ext.viewcode",
    "sphinx.ext.napoleon",
    "sphinx.ext.extlinks",
    "sphinx.ext.todo",
    "sphinx.ext.graphviz",
    "sphinx.ext.inheritance_diagram",
    "sphinx.ext.githubpages",
]

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

# The suffix of source filenames.
source_suffix = ".rst"

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

# The master toctree document.
master_doc = "index"

# General information about the project.
project = doc_module.__name__
copyright = ""
if hasattr(doc_module, "__copyright__"):
    copyright = doc_module.__copyright__

# 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 = "0.0.0"
if hasattr(doc_module, "__version__"):
    version = doc_module.__version__
# The full version, including alpha/beta/rc tags.
release = version

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

# 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.
exclude_patterns = []

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

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

# 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


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

# 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 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 = "Bandersnatch documentation"

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = "Bandersnatch documentation"

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None

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

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

# Output file base name for HTML help builder.
htmlhelp_basename = doc_module.__name__
html_theme = "default"

# Determine available themes and settings
available_themes = ["default"]
available_theme_settings = {}
try:
    import cloud_sptheme as csp

    available_themes.insert(0, "cloudsp")
    available_theme_settings["cloudsp"] = {}
    available_theme_settings["cloudsp"]["theme"] = "cloud"
    available_theme_settings["cloudsp"]["path"] = [csp.get_theme_dir()]
    available_theme_settings["cloudsp"]["options"] = {"roottarget": "index"}
except ImportError:
    pass

try:
    import sphinx_bootstrap_theme

    available_themes.insert(0, "bootstrap")
    available_theme_settings["bootstrap"] = {}
    available_theme_settings["bootstrap"]["theme"] = "bootstrap"
    available_theme_settings["bootstrap"][
        "path"
    ] = sphinx_bootstrap_theme.get_html_theme_path()
    available_theme_settings["bootstrap"]["options"] = {
        # lumen, journal
        "bootswatch_theme": os.environ.get("SPHINX_BOOTSWATCH_THEME", "journal")
    }
except ImportError:
    pass

try:
    import guzzle_sphinx_theme

    available_themes.insert(0, "guzzle")
    available_theme_settings["guzzle"] = {}
    available_theme_settings["guzzle"]["theme"] = "guzzle_sphinx_theme"
    available_theme_settings["guzzle"]["path"] = guzzle_sphinx_theme.html_theme_path()
    available_theme_settings["guzzle"]["options"] = {}
except ImportError:
    pass

try:
    import sphinx_rtd_theme

    available_themes.insert(0, "read_the_docs")
    available_theme_settings["read_the_docs"] = {}
    available_theme_settings["read_the_docs"]["theme"] = "sphinx_rtd_theme"
    available_theme_settings["read_the_docs"]["path"] = [
        sphinx_rtd_theme.get_html_theme_path()
    ]
    available_theme_settings["read_the_docs"]["options"] = {
        "collapse_navigation": os.environ.get("SPHINX_COLLAPSE_NAVIGATION", True),
        "display_version": os.environ.get("SPHINX_DISPLAY_VERSION", version != "0.0.0"),
        "navigation_depth": os.environ.get("SPHINX_NAVIGATION_DEPTH", 3),
    }
except ImportError:
    pass

try:
    import pypa_theme  # noqa: F401

    available_themes.insert(0, "pypa")
    available_theme_settings["pypa"] = {}
    available_theme_settings["pypa"]["theme"] = "pypa_theme"
    available_theme_settings["pypa"]["path"] = []
    available_theme_settings["pypa"]["options"] = {}
except ImportError:
    pass

selected_theme = os.environ.get("SPHINX_THEME", available_themes[0])
if selected_theme not in available_themes:
    selected_theme = available_themes[0]
    print(f"SPHINX_THEME is not installed, using {selected_theme!r} theme")

html_theme = available_theme_settings[selected_theme]["theme"]
html_theme_path = available_theme_settings[selected_theme]["path"]
if available_theme_settings[selected_theme].get("options", None):
    html_theme_options = available_theme_settings[selected_theme]["options"]

try:
    from recommonmark.parser import CommonMarkParser
    from recommonmark.transform import AutoStructify

    # TODO: "source_parsers" is deprecated. Please use app.add_source_parser()
    source_parsers = {".md": CommonMarkParser}

    source_suffix = [".rst", ".md"]
    github_doc_root = "https://partner.git.corp.yahoo.com/pages/yahoo.platform_init"
    USE_MARKDOWN = True
except ImportError:
    USE_MARKDOWN = False

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

# 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 = [
    (
        "index",
        doc_module.__name__ + ".tex",
        doc_module.__name__ + " Documentation",
        "PyPA",
        "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 manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ("index", doc_module.__name__, doc_module.__name__ + " Documentation", [""], 1)
]

# If true, show URL addresses after external links.
# man_show_urls = False


# -- 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 = [
    (
        "index",
        doc_module.__name__,
        doc_module.__name__ + " Documentation",
        "",
        doc_module.__name__,
        doc_module.__name__ + " Documentation",
        "Miscellaneous",
    )
]

# 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

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    "python": ("http://docs.python.org/3", None),
    "urllib3": ("http://urllib3.readthedocs.org/en/latest", None),
    "requests": ("http://docs.python-requests.org/en/latest/", None),
}

# Useful external link shortcuts
extlinks = {"issue": ("https://github.com/sphinx-doc/sphinx/issues/%s", "issue ")}


def setup(app):
    if USE_MARKDOWN:
        print("Adding recommonmark settings")
        app.add_config_value(
            "recommonmark_config",
            {
                "url_resolver": lambda url: github_doc_root + url,
                "auto_toc_tree_section": "Contents",
                "enable_eval_rst": True,
            },
            True,
        )
        app.add_transform(AutoStructify)
