master

import os

import sys

from configparser import RawConfigParser

import sphinx_rtd_theme

sys.path.insert(0, os.path.abspath('..'))

sys.path.append(os.path.dirname(__file__))

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "readthedocs.settings.dev")

from django.conf import settings

from django.utils import timezone

import django

django.setup()

def get_version():

    """Return package version from setup.cfg."""

    config = RawConfigParser()

    config.read(os.path.join('..', 'setup.cfg'))

    return config.get('metadata', 'version')

sys.path.append(os.path.abspath('_ext'))

extensions = [

    'sphinx.ext.autosectionlabel',

    'sphinx.ext.autodoc',

    'sphinx.ext.intersphinx',

    'sphinxcontrib.httpdomain',

    'djangodocs',

    'doc_extensions',

    'sphinx_tabs.tabs',

    'sphinx-prompt',

    'recommonmark',

    'notfound.extension',

    'hoverxref.extension',

    'sphinx_search.extension',

    'sphinxemoji.sphinxemoji',

]

templates_path = ['_templates']

source_suffix = ['.rst', '.md']

master_doc = 'index'

project = u'Read the Docs'

copyright = '2010-{}, Read the Docs, Inc & contributors'.format(

    timezone.now().year

)

version = get_version()

release = version

exclude_patterns = ['_build']

default_role = 'obj'

intersphinx_mapping = {

    'python': ('https://docs.python.org/3.6/', None),

    'django': ('https://docs.djangoproject.com/en/1.11/', 'https://docs.djangoproject.com/en/1.11/_objects/'),

    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),

    'pip': ('https://pip.pypa.io/en/stable/', None),

}

htmlhelp_basename = 'ReadTheDocsdoc'

latex_documents = [

    ('index', 'ReadTheDocs.tex', u'Read the Docs Documentation',

     u'Eric Holscher, Charlie Leifer, Bobby Grace', 'manual'),

]

man_pages = [

    ('index', 'read-the-docs', u'Read the Docs Documentation',

     [u'Eric Holscher, Charlie Leifer, Bobby Grace'], 1)

]

exclude_patterns = [

    # 'api' # needed for ``make gettext`` to not die.

]

language = 'en'

locale_dirs = [

    'locale/',

]

gettext_compact = False

html_theme = 'sphinx_rtd_theme'

html_static_path = ['_static']

html_js_files = ['js/expand_tabs.js']

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

html_logo = 'img/logo.svg'

html_theme_options = {

    'logo_only': True,

    'display_version': False,

}

hoverxref_auto_ref = True

hoverxref_domains = ['py']

hoverxref_roles = [

    'option',

    'doc',

]

hoverxref_role_types = {

    'mod': 'modal',  # for Python Sphinx Domain

    'doc': 'modal',  # for whole docs

    'class': 'tooltip',  # for Python Sphinx Domain

    'ref': 'tooltip',  # for hoverxref_auto_ref config

    'confval': 'tooltip',  # for custom object

}

rst_epilog = """

.. |org_brand| replace:: Read the Docs Community

.. |com_brand| replace:: Read the Docs for Business

"""

# Activate autosectionlabel plugin

autosectionlabel_prefix_document = True

numfig = True

# sphinx-notfound-page

# https://github.com/readthedocs/sphinx-notfound-page

notfound_context = {

    'title': 'Page Not Found',

    'body': '''

<h1>Page Not Found</h1>

<p>Sorry, we couldn't find that page.</p>

<p>Try using the search box or go to the homepage.</p>

''',

}

linkcheck_ignore = [

    r'http://127\.0\.0\.1',

    r'http://localhost',

    r'http://community\.dev\.readthedocs\.io',

    r'https://yourproject\.readthedocs\.io',

    r'https?://docs\.example\.com',

    r'https://foo\.readthedocs\.io/projects',

    r'https://github\.com.+?#L\d+',

    r'https://github\.com/readthedocs/readthedocs\.org/issues',

    r'https://github\.com/readthedocs/readthedocs\.org/pull',

    r'https://docs\.readthedocs\.io/\?rtd_search',

    r'https://readthedocs\.org/search',

    # This page is under login

    r'https://readthedocs\.org/accounts/gold',

]

def setup(app):

    app.add_css_file('css/sphinx_prompt_css.css')

 No newline at end of file