conf.py 5.38 KB
Newer Older
Chaos's avatar
Chaos committed
1 2 3
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
Chaos's avatar
Chaos committed
4
# OwlGaming documentation build configuration file, created by
Chaos's avatar
Chaos committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
# sphinx-quickstart on Sun Apr 23 15:37:03 2017.
#
# 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.

# 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.
#
Chaos's avatar
Chaos committed
20
import os
Chaos's avatar
Chaos committed
21 22 23
# import sys
# sys.path.insert(0, os.path.abspath('.'))
from recommonmark.parser import CommonMarkParser
Chaos's avatar
Chaos committed
24

Chaos's avatar
Chaos committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38

# -- 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 = ['sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
Chaos's avatar
Chaos committed
39
    'sphinx.ext.githubpages']
Chaos's avatar
Chaos committed
40 41 42 43 44 45 46 47 48 49 50 51

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

source_parsers = {
    '.md': CommonMarkParser,
}

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
Chaos's avatar
Chaos committed
52
source_suffix = ['.rst', '.md']
Chaos's avatar
Chaos committed
53 54 55 56 57

# The master toctree document.
master_doc = 'index'

# General information about the project.
Chaos's avatar
Chaos committed
58
project = 'OwlGaming'
Chaos's avatar
Chaos committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
copyright = '2017, OwlGaming Community'
author = 'OwlGaming Community'

# 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.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
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']

# 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


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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
Chaos's avatar
Chaos committed
95 96 97 98 99
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd:  # only import and set the theme if we're building docs locally
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
Chaos's avatar
Chaos committed
100 101 102 103 104

# 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.
#
Chaos's avatar
Chaos committed
105 106 107 108 109 110
html_theme_options = {
    'collapse_navigation': False,
    'display_version': False,
    'canonical_url': 'https://docs.owlgaming.net/',
    'sticky_navigation': True
}
Chaos's avatar
Chaos committed
111 112 113 114 115 116 117 118 119 120

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


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
Chaos's avatar
Chaos committed
121
htmlhelp_basename = 'OwlGamingdoc'
Chaos's avatar
Chaos committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147


# -- 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 = [
Chaos's avatar
Chaos committed
148
    (master_doc, 'OwlGaming.tex', 'OwlGaming Documentation',
Chaos's avatar
Chaos committed
149 150 151 152 153 154 155 156 157
     'OwlGaming Community', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
Chaos's avatar
Chaos committed
158
    (master_doc, 'owlgaming', 'OwlGaming Documentation',
Chaos's avatar
Chaos committed
159 160 161 162 163 164 165 166 167 168
     [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 = [
Chaos's avatar
Chaos committed
169 170
    (master_doc, 'OwlGaming', 'OwlGaming Documentation',
     author, 'OwlGaming', 'One line description of project.',
Chaos's avatar
Chaos committed
171 172 173 174 175 176 177 178
     'Miscellaneous'),
]




# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}