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

import os

import sys

from datetime import date

import yaml

import re

from docutils import nodes

from sphinx.util import logging

from recommonmark.transform import AutoStructify

from recommonmark.parser import CommonMarkParser, splitext, urlparse

from sphinx_scylladb_theme.utils import multiversion_regex_builder

logger = logging.getLogger(__name__)

# -- 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.todo',

'sphinx.ext.mathjax',

'sphinx.ext.githubpages',

'sphinx.ext.extlinks',

'sphinx.ext.autosectionlabel',

'sphinx_scylladb_theme',

'sphinx_multiversion',

]

# The suffix(es) of source filenames.

# You can specify multiple suffix as a list of string:

#

source_suffix = {

'.rst': 'restructuredtext',

'.md': 'markdown',

}

autosectionlabel_prefix_document = True

class CustomCommonMarkParser(CommonMarkParser):

def visit_document(self, node):

pass

def visit_link(self, mdnode):

# Override to avoid checking if relative links exists

ref_node = nodes.reference()

destination = mdnode.destination

_, ext = splitext(destination)

url_check = urlparse(destination)

scheme_known = bool(url_check.scheme)

if not scheme_known and ext.replace('.', '') in self.supported:

destination = destination.replace(ext, '')

ref_node['refuri'] = destination

ref_node.line = self._get_line(mdnode)

if mdnode.title:

ref_node['title'] = mdnode.title

next_node = ref_node

self.current_node.append(next_node)

self.current_node = ref_node

def replace_relative_links(app, docname, source):

result = source[0]

for key in app.config.replacements:

result = re.sub(key, app.config.replacements[key], result)

source[0] = result

def setup(app):

app.add_source_parser(CustomCommonMarkParser)

app.add_config_value('recommonmark_config', {

'enable_eval_rst': True,

'enable_auto_toc_tree': False,

}, True)

app.add_transform(AutoStructify)

# Replace DataStax links

replacements = {r'https://docs.datastax.com/en/drivers/java\/(.*?)\/': "https://java-driver.docs.scylladb.com/latest/api/"}

app.add_config_value('replacements', replacements, True)

app.connect('source-read', replace_relative_links)

# The master toctree document.

master_doc = 'contents'

# General information about the project.

project = 'Scylla Java Driver'

copyright = str(date.today().year) + ', ScyllaDB. All rights reserved.'

author = u'Scylla Project Contributors'

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

# The full version, including alpha/beta/rc tags.

release = u'3.7.1'

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

language = None

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This patterns also effect to html_static_path and html_extra_path

exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'lib', 'lib64','**/_common/*', 'README.md', '.git', '.github', '_utils', '_templates', 'rst_include']

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

pygments_style = 'sphinx'

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

todo_include_todos = True

# Custom lexer

from pygments.lexers.shell import BashLexer

from sphinx.highlighting import lexers

class DitaaLexer(BashLexer):

pass

lexers['ditaa'] = DitaaLexer(startinline=True)

# Adds version variables for monitoring and manager versions when used in inline text

rst_epilog = """

.. |mon_version| replace:: 3.1

.. |man_version| replace:: 2.0

.. |mon_root| replace:: :doc:`Scylla Monitoring Stack </operating-scylla/monitoring/index>`

"""

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

# html_theme_path = ["../.."]

html_style = ''

# 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 = {

'header_links': [

('Scylla Java Driver', 'https://java-driver.docs.scylladb.com/'),

('Scylla Cloud', 'https://docs.scylladb.com/scylla-cloud/'),

('Scylla University', 'https://university.scylladb.com/'),

('ScyllaDB Home', 'https://www.scylladb.com/')],

'github_issues_repository': 'scylladb/java-driver',

'show_sidebar_index': True,

}

extlinks = {

'manager': ('/operating-scylla/manager/%s/',''),

'manager_lst': ('/operating-scylla/manager/2.0/%s/',''),

'monitor': ('/operating-scylla/monitoring/%s/',''),

'monitor_lst': ('/operating-scylla/monitoring/3.1/%s/','')

}

# If not None, a 'Last updated on:' timestamp is inserted at every page

# bottom, using the given strftime format.

# The empty string is equivalent to '%b %d, %Y'.

#

html_last_updated_fmt = '%d %B %Y'

# Custom sidebar templates, maps document names to template names.

#

html_sidebars = {'**': ['side-nav.html']}

# Output file base name for HTML help builder.

htmlhelp_basename = 'ScyllaDocumentationdoc'

# URL which points to the root of the HTML documentation.

html_baseurl = 'https://java-driver.docs.scylladb.com'

# Dictionary of values to pass into the template engine’s context for all pages

html_context = {'html_baseurl': html_baseurl}

# -- Options for not found extension -------------------------------------------

# Template used to render the 404.html generated by this extension.

notfound_template = '404.html'

# Prefix added to all the URLs generated in the 404 page.

notfound_urls_prefix = ''

# -- Options for redirect extension ---------------------------------------

# Read a YAML dictionary of redirections and generate an HTML file for each

redirects_file = "_utils/redirections.yaml"

# -- Options for multiversion extension ----------------------------------

# Whitelist pattern for tags (set to None to ignore all tags)

TAGS = []

smv_tag_whitelist = multiversion_regex_builder(TAGS)

# Whitelist pattern for branches (set to None to ignore all branches)

smv_branch_whitelist = r"^latest$"

# Defines which version is considered to be the latest stable version.

# Must be listed in smv_tag_whitelist or smv_branch_whitelist.

smv_latest_version = 'latest'

smv_rename_latest_version = ''

# Whitelist pattern for remotes (set to None to use local branches only)

smv_remote_whitelist = r"^origin$"

# Pattern for released versions

smv_released_pattern = r'^tags/.*$'

# Format for versioned output directories inside the build directory

smv_outputdir_format = '{ref.name}'

# -- 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, 'ScyllaDocumentation.tex', u'Scylla Documentation Documentation',

u'Scylla Project Contributors', '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, 'scylladocumentation', u'Scylla Documentation 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, 'ScyllaDocumentation', u'Scylla Documentation Documentation',

author, 'ScyllaDocumentation', 'One line description of project.',

'Miscellaneous'),

]

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

# Bibliographic Dublin Core info.

epub_title = project

epub_author = author

epub_publisher = author

epub_copyright = copyright

# A list of files that should not be packed into the epub file.

epub_exclude_files = ['search.html']