conf.py

# Read the Docs Blog documentation build configuration file, created by
# sphinx-quickstart on Thu Jul 31 11:23:11 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import ablog

# 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.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.abspath('exts'))

# -- 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.
extensions = [
    'ablog',
    'sphinx.ext.intersphinx',
    'atom_absolute',
    'sphinxext.opengraph',
]

blog_title = 'Read the Docs Blog'
blog_baseurl = 'https://blog.readthedocs.com'
blog_path = 'archive'
fontawesome_link_cdn = 'https://netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.min.css'
# fontawesome_included = True
# disqus_shortname = 'readthedocsblog'
post_auto_excerpt = 2

blog_authors = {
    'Eric': ('Eric Holscher', 'http://ericholscher.com'),
    'Anthony': ('Anthony Johnson', 'http://ohess.org'),
    'David': ('David Fischer', ''),
    'Safwan': ('Safwan Rahman', 'https://github.com/safwanrahman/'),
    'Santos': ('Santos Gallegos', 'https://github.com/stsewd/'),
    'Saadmk11': ('Maksudul Haque', 'https://github.com/saadmk11/'),
    'Vaibhav': ('Vaibhav Gupta', 'https://github.com/dojutsu-user'),
    'Manuel': ('Manuel Kaufmann', 'https://elblogdehumitos.com/'),
    'Juan Luis': ('Juan Luis Cano Rodríguez', 'https://github.com/astrojuanlu/'),
    'Ben': ('Benjamin Balder Bach', 'https://overtag.dk/'),
}
blog_default_author = 'Eric'

blog_locations = {
    'PDX': ('Portland, Oregon', 'http://www.portlandhikersfieldguide.org/'),
    'BND': ('Bend, Oregon', 'https://www.visitbend.com/'),
    'SAN': ('San Diego, CA', ''),
    'DHA': ('Dhaka, Bangladesh', 'https://wikitravel.org/en/Bangladesh'),
    'CUE': ('Cuenca, Ecuador', ''),
    'LKO': ('Lucknow, India', ''),
    'BCN': ('Barcelona, Spain', 'https://www.barcelona.cat/en/'),
    'MAD': ('Madrid, Spain', 'https://www.esmadrid.com/en'),
    'GEG': ('Spokane, Washington', ''),
    'MLM': ('Malmö, Sweden', ''),
}
blog_default_location = 'PDX'
blog_feed_archives = True
blog_feed_fulltext = True
blog_feed_length = 1

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path.append(os.path.join(
    '_themes', 'rtd-blog'
))
templates_path.append(ablog.get_html_templates_path())

if os.environ.get('READTHEDOCS', None) == 'True':
    skip_pickling = True


# 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 = u'Read the Docs Blog'
copyright = u'Read the Docs, Inc'

# 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 = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'

# 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 = ['_build', 'hiring', '.direnv']

# 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 = 'rtd-blog'
html_theme_path = ['_themes']

html_theme_options = {
}

# 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 = 'Read the Docs Blog'

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

# 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 = {
   '**': [
          'postcard.html',
          'social.html',
          'recentposts.html',
          'categories.html',
          'archives.html'
         ]
}

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

# This may be elevated as a general issue for documentation and behavioral
# change to the Sphinx build:
# https://github.com/readthedocs/readthedocs.org/issues/10226
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/")

intersphinx_mapping = {
    'readthedocs': (
        'https://docs.readthedocs.io/en/stable',
        None
    ),
    'jupyterbook': (
        'https://jupyterbook.org/',
        None
    ),
    'hoverxref': (
        'https://sphinx-hoverxref.readthedocs.io/en/stable',
        None
    ),
    'sphinx': (
        'https://www.sphinx-doc.org/en/master/',
        None
    ),
    'myst-parser': (
        'https://myst-parser.readthedocs.io/en/v0.16.0/',
        None
    ),
}

ogp_site_name = "Read the Docs Blog"
# ogp_use_first_image = True  # https://github.com/readthedocs/blog/pull/118
ogp_image = (
    'https://blog.readthedocs.com/'
    '_static/logo-opengraph.png'
)
# Inspired by https://github.com/executablebooks/MyST-Parser/pull/404/
ogp_custom_meta_tags = [
    '<meta name="twitter:card" content="summary_large_image" />',
]
ogp_use_first_image = True  # https://github.com/readthedocs/blog/pull/118
ogp_enable_meta_description = True
ogp_description_length = 300


# -- 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', 'ReadtheDocsBlog.tex', u'Read the Docs Blog',
   u'Eric Holscher', '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', 'readthedocsblog', u'Read the Docs Blog',
     [u'Eric Holscher'], 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', 'ReadtheDocsBlog', u'Read the Docs Blog',
   u'Eric Holscher', 'ReadtheDocsBlog', 'One line description of project.',
   '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


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

# Bibliographic Dublin Core info.
epub_title = u'Read the Docs Blog'
epub_author = u'Eric Holscher'
epub_publisher = u'Eric Holscher'
epub_copyright = u'2014, Eric Holscher'

# The basename for the epub file. It defaults to the project name.
#epub_basename = u'Read the Docs Blog'

# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'

# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''

# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''

# 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 tuple containing the cover image and cover page html template filenames.
#epub_cover = ()

# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()

# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []

# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []

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

# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3

# Allow duplicate toc entries.
#epub_tocdup = True

# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'

# Fix unsupported image types using the PIL.
#epub_fix_images = False

# Scale large images.
#epub_max_image_width = 0

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'

# If false, no index is generated.
#epub_use_index = True

# See dev/style_guide.rst for documentation
rst_epilog = """
.. |org_brand| replace:: Read the Docs Community
.. |com_brand| replace:: Read the Docs for Business
.. |git_providers_and| replace:: GitHub, Bitbucket, and GitLab
.. |git_providers_or| replace:: GitHub, Bitbucket, or GitLab
"""