conf.py (2276B)
1 # coding: utf-8 2 # 3 # youtube-dl documentation build configuration file, created by 4 # sphinx-quickstart on Fri Mar 14 21:05:43 2014. 5 # 6 # This file is execfile()d with the current directory set to its 7 # containing dir. 8 # 9 # Note that not all possible configuration values are present in this 10 # autogenerated file. 11 # 12 # All configuration values have a default; values that are commented out 13 # serve to show the default. 14 15 import sys 16 import os 17 # Allows to import youtube_dl 18 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) 19 20 # -- General configuration ------------------------------------------------ 21 22 # Add any Sphinx extension module names here, as strings. They can be 23 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 24 # ones. 25 extensions = [ 26 'sphinx.ext.autodoc', 27 ] 28 29 # Add any paths that contain templates here, relative to this directory. 30 templates_path = ['_templates'] 31 32 # The suffix of source filenames. 33 source_suffix = '.rst' 34 35 # The master toctree document. 36 master_doc = 'index' 37 38 # General information about the project. 39 project = u'youtube-dl' 40 copyright = u'2014, Ricardo Garcia Gonzalez' 41 42 # The version info for the project you're documenting, acts as replacement for 43 # |version| and |release|, also used in various other places throughout the 44 # built documents. 45 # 46 # The short X.Y version. 47 from youtube_dl.version import __version__ 48 version = __version__ 49 # The full version, including alpha/beta/rc tags. 50 release = version 51 52 # List of patterns, relative to source directory, that match files and 53 # directories to ignore when looking for source files. 54 exclude_patterns = ['_build'] 55 56 # The name of the Pygments (syntax highlighting) style to use. 57 pygments_style = 'sphinx' 58 59 # -- Options for HTML output ---------------------------------------------- 60 61 # The theme to use for HTML and HTML Help pages. See the documentation for 62 # a list of builtin themes. 63 html_theme = 'default' 64 65 # Add any paths that contain custom static files (such as style sheets) here, 66 # relative to this directory. They are copied after the builtin static files, 67 # so a file named "default.css" will overwrite the builtin "default.css". 68 html_static_path = ['_static'] 69 70 # Output file base name for HTML help builder. 71 htmlhelp_basename = 'youtube-dldoc'