conf.py 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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. import sys
  15. import os
  16. # Allows to import youtube_dl
  17. sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
  18. # -- General configuration ------------------------------------------------
  19. # Add any Sphinx extension module names here, as strings. They can be
  20. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  21. # ones.
  22. extensions = [
  23. 'sphinx.ext.autodoc',
  24. ]
  25. # Add any paths that contain templates here, relative to this directory.
  26. templates_path = ['_templates']
  27. # The suffix of source filenames.
  28. source_suffix = '.rst'
  29. # The master toctree document.
  30. master_doc = 'index'
  31. # General information about the project.
  32. project = u'youtube-dl'
  33. copyright = u'2014, Ricardo Garcia Gonzalez'
  34. # The version info for the project you're documenting, acts as replacement for
  35. # |version| and |release|, also used in various other places throughout the
  36. # built documents.
  37. #
  38. # The short X.Y version.
  39. from youtube_dl.version import __version__
  40. version = __version__
  41. # The full version, including alpha/beta/rc tags.
  42. release = version
  43. # List of patterns, relative to source directory, that match files and
  44. # directories to ignore when looking for source files.
  45. exclude_patterns = ['_build']
  46. # The name of the Pygments (syntax highlighting) style to use.
  47. pygments_style = 'sphinx'
  48. # -- Options for HTML output ----------------------------------------------
  49. # The theme to use for HTML and HTML Help pages. See the documentation for
  50. # a list of builtin themes.
  51. html_theme = 'default'
  52. # Add any paths that contain custom static files (such as style sheets) here,
  53. # relative to this directory. They are copied after the builtin static files,
  54. # so a file named "default.css" will overwrite the builtin "default.css".
  55. html_static_path = ['_static']
  56. # Output file base name for HTML help builder.
  57. htmlhelp_basename = 'youtube-dldoc'