# -*- coding: utf-8 -*-

# -- Roundup Notice --
# This conf.py is used for Roundup website and it is different
# from doc/conf.py in that it doesn't copy extra HTML files, which
# are copied manually using instructions in README.txt
# ---

# Roundup documentation build configuration file, created by
# sphinx-quickstart on Tue Jan 20 17:33:20 2009.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# Read Roundup version by importing it from root of checkout.
# this ensures that 'unknown version' is inserted even if
# `roundup` is importable from other location in sys.path
SYSSAVE = sys.path
DOCROOT = os.path.abspath(os.path.dirname(__file__) + "/..")
sys.path = [os.path.dirname(DOCROOT)]
try:
    if "RELEASE_VERSION" in os.environ:
        SHORTVER = '.'.join(os.environ['RELEASE_VERSION'].split('.', 2)[:2])
        VERSION = os.environ['RELEASE_VERSION']
    else:
        from roundup import __version__ as VERSION
        SHORTVER = '.'.join(VERSION.split('.', 2)[:2])
except ImportError:
    VERSION = SHORTVER = '(unknown version)'
finally:
    sys.path = SYSSAVE

# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.append(os.path.abspath('.'))

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

# 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', 'sphinxext.opengraph',
              'sphinx_sitemap', 'sphinx_tabs.tabs']

sphinx_tabs_valid_builders = ['linkcheck']
sphinx_tabs_disable_tab_closing = True
ogp_site_url = "https://www.roundup-tracker.org"
ogp_image = "_images/index_logged_out.png"
ogp_image_alt = "The front page of a tracker showing a table of issues and their properties."
# ogp_description_length = 200

# for sitemap default: "{lang}{version}subdir/{link}"
sitemap_url_scheme = "{link}"

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

# The master toctree document.
master_doc = 'contents'

# General information about the project.
project = u'Roundup'
copyright = u'2009-2025, Richard Jones, Roundup-Team'

# 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 = SHORTVER
# 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 = 'en'

# 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 documents that shouldn't be included in the build.
exclude_patterns = ['docs/index.txt',
                    'docs/whatsnew-0.7.txt',
                    'docs/whatsnew-0.8.txt',
                    'robots.txt',
                    'docs/tracker_config.txt',
                    'COPYING.txt',
                    'docs/CVE.txt',
                    '_tmp']

# 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 = 'borland'


# Options for HTML output
# -----------------------

# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
html_style = ''
# 'default.css'

# 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 base URL which points to the root of the HTML documentation. It is
# used to indicate the location of document using The Canonical Link Relation.
html_baseurl = "https://www.roundup-tracker.org/"

# 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 = '_static/favicon.ico'

# 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.
#html_use_smartypants = True

# A list of paths that contain extra files not directly related to the
# documentation, such as robots.txt or .htaccess. Relative paths are
# taken as relative to the configuration directory. They are copied to
# the output directory. They will overwrite any existing file of the
# same name.
# Warns that robots.txt is not in TOC tree. Causes build to fail with
# sphinx-build -W. So install robots.txt via Makefile.
# html_extra_path = ['robots.txt']

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

html_collapse_toctree = True

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# disable permalinks
from sphinx import version_info
if version_info < (3,5,0):
    html_add_permalinks = ''
else:
    html_permalinks = False  # when sphinx > 3.5 is used.

# If false, no module index is generated.
#html_use_modindex = 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, the reST sources are included in the HTML build as _sources/<name>.
#html_copy_source = 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_baseurl

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''

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


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

# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
latex_documents = [
  ('docs/index', 'Roundup.tex', u'Roundup Documentation',
   u'Richard Jones', '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

# Additional stuff for the LaTeX preamble.
#latex_preamble = ''

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_use_modindex = True


linkcheck_ignore = [
    r'https?://.*localhost:\d+/',
    r'http://www.zope.com/Marks',        # reference in license
    r'http://www.ekit.com/',             # reference in license
    r'http://www.bizarsoftware.com.au/', # reference in license,
    r'http://11.11.11.101',              # dummy example url
    r'https://.../rest/.*',              # dummy example url
    r'http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ZPTInternationalizationSupport',                 # dead link, there for historic
]

linkcheck_timeout = 10  # seconds