File: conf.py

package info (click to toggle)
pmbootstrap 3.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,852 kB
  • sloc: python: 17,099; sh: 425; makefile: 17
file content (35 lines) | stat: -rw-r--r-- 1,078 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
# Copyright 2024 Robert Eckelmann
# SPDX-License-Identifier: GPL-3.0-or-later
# Configuration file for the Sphinx documentation builder.

import sys
import os
import datetime

sys.path.insert(0, os.path.abspath(".."))  # Allow modules to be found

project = "pmbootstrap"
copyright = str(datetime.date.today().year) + ", postmarketOS contributors"
extensions = [
    "myst_parser",
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.doctest",
    "sphinxcontrib.autoprogram",
    "sphinxcontrib.jquery",
]
exclude_patterns = ["_build", "_out", "Thumbs.db", ".DS_Store", ".venv", "README.md"]

html_theme = "pmos"
html_theme_options = {
    "source_edit_link": "https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/blob/master/docs/{filename}",
}

# Output file base name for HTML help builder.
htmlhelp_basename = "pmbootstrapdoc"

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ("index", "pmbootstrap", "pmbootstrap Documentation", ["postmarketOS Contributors"], 1)
]