File: conf.py

package info (click to toggle)
sphinxcontrib-video 0.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,484 kB
  • sloc: python: 368; makefile: 18; sh: 17
file content (49 lines) | stat: -rw-r--r-- 1,406 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
"""Configuration file for the Sphinx documentation builder.

This file only contains a selection of the most common options. For a full
list see the documentation:
https://www.sphinx-doc.org/en/master/usage/configuration.html
"""

# -- Path setup ----------------------------------------------------------------

import os
import sys
from datetime import datetime

sys.path.insert(0, os.path.abspath(".."))

# -- Project information -------------------------------------------------------

project = "sphinxcontrib-video"
author = "Raphael Massabot"
copyright = f"2018-{datetime.now().year}, {author}"
release = "0.4.2"

# -- General configuration -----------------------------------------------------

extensions = ["sphinxcontrib.video", "sphinx_design"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

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

html_theme = "pydata_sphinx_theme"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
html_context = {
    "github_user": "sphinx-contrib",
    "github_repo": "video",
    "github_version": "master",
    "doc_path": "docs",
}
html_theme_options = {
    "logo": {"text": project},
    "use_edit_page_button": True,
    "icon_links": [
        {
            "name": "GitHub",
            "url": "https://github.com/sphinx-contrib/video",
            "icon": "fa-brands fa-github",
        }
    ],
}