docs/conf.py

   1 # -*- coding: utf-8 -*-
   2
   3 extensions = [
   4     'sphinx.ext.todo',
   5     'sphinx.ext.intersphinx',
   6     'sphinx.ext.extlinks',
   7 ]
   8
   9 intersphinx_mapping = {
  10     'gtk': ('https://lazka.github.io/pgi-docs/Gtk-3.0', None),
  11     'gobject': ('https://lazka.github.io/pgi-docs/GObject-2.0', None),
  12     'glib': ('https://lazka.github.io/pgi-docs/GLib-2.0', None),
  13     'gdk': ('https://lazka.github.io/pgi-docs/Gdk-3.0', None),
  14     'gio': ('https://lazka.github.io/pgi-docs/Gio-2.0', None),
  15     'python2': ('https://docs.python.org/2.7', None),
  16     'python3': ('https://docs.python.org/3', None),
  17     'cairo': ('https://pycairo.readthedocs.io/en/latest', None),
  18 }
  19
  20 source_suffix = '.rst'
  21 master_doc = 'index'
  22 exclude_patterns = ['_build', 'README.rst']
  23
  24 pygments_style = 'tango'
  25 html_theme = 'sphinx_rtd_theme'
  26 html_show_copyright = False
  27 html_favicon = "images/favicon.ico"
  28 project = "PyGObject"
  29 html_title = project
  30
  31 html_context = {
  32     'extra_css_files': [
  33         'https://quodlibet.github.io/fonts/font-mfizz.css',
  34         '_static/extra.css',
  35     ],
  36     "display_gitlab": True,
  37     "gitlab_user": "GNOME",
  38     "gitlab_repo": "pygobject",
  39     "gitlab_version": "master",
  40     "conf_py_path": "/docs/",
  41     "gitlab_host": "gitlab.gnome.org",
  42 }
  43
  44 html_static_path = [
  45     "extra.css",
  46     "images/pygobject-small.svg",
  47 ]
  48
  49 html_theme_options = {
  50     "display_version": False,
  51 }
  52
  53 extlinks = {
  54     'bzbug': ('https://bugzilla.gnome.org/show_bug.cgi?id=%s', 'bz#'),
  55     'issue': ('https://gitlab.gnome.org/GNOME/pygobject/issues/%s', '#'),
  56     'commit': ('https://gitlab.gnome.org/GNOME/pygobject/commit/%s', ''),
  57     'mr': (
  58         'https://gitlab.gnome.org/GNOME/pygobject/merge_requests/%s', '!'),
  59     'user': ('https://gitlab.gnome.org/%s', ''),
  60 }
  61
  62 suppress_warnings = ["image.nonlocal_uri"]