FilesExpand file tree

master

/

conf.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

72 lines (64 loc) · 2.43 KB

master

/

conf.py

Copy path

Top

File metadata and controls

• Code
• Blame

72 lines (64 loc) · 2.43 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

"""Sphinx documentation configuration for tmuxp."""

from __future__ import annotations

import pathlib

import sys

# Get the project root dir, which is the parent dir of this

cwd = pathlib.Path(__file__).parent

project_root = cwd.parent

src_root = project_root / "src"

sys.path.insert(0, str(src_root))

sys.path.insert(0, str(cwd / "_ext")) # for local aafig extension

# package data

about: dict[str, str] = {}

with (src_root / "tmuxp" / "__about__.py").open() as fp:

exec(fp.read(), about)

from gp_sphinx.config import make_linkcode_resolve, merge_sphinx_config # noqa: E402

import tmuxp # noqa: E402

conf = merge_sphinx_config(

project=about["__title__"],

version=about["__version__"],

copyright=about["__copyright__"],

source_repository=f"{about['__github__']}/",

docs_url=about["__docs__"],

source_branch="master",

light_logo="img/tmuxp.svg",

dark_logo="img/tmuxp.svg",

extra_extensions=[

"sphinx_autodoc_api_style",

"aafig",

"sphinx_gp_mermaid",

"sphinx_gp_highlighting",

"tmux_layout",

"sphinx_autodoc_argparse.exemplar",

],

gp_highlighting_inline_literals="safe",

gp_highlighting_inline_commands=["tmuxp"],

# Route a plain ```mermaid fence to the mermaid directive (the colon and

# brace forms route there already via colon_fence). Redundant once the

# pinned gp-sphinx release auto-routes when sphinx_gp_mermaid is active;

# drop this on the next gp-sphinx bump.

myst_fence_as_directive=["mermaid"],

intersphinx_mapping={

"python": ("https://docs.python.org/", None),

"libtmux": ("https://libtmux.git-pull.com/", None),

},

linkcode_resolve=make_linkcode_resolve(tmuxp, about["__github__"]),

# tmuxp-specific overrides

theme_options={"mask_icon": "/_static/img/tmuxp.svg"},

html_extra_path=["manifest.json"],

html_favicon="_static/favicon.ico",

aafig_format={"latex": "pdf", "html": "gif"},

aafig_default_options={"scale": 0.75, "aspect": 0.5, "proportional": True},

rediraffe_redirects="redirects.txt",

# Keep Sphinx out of non-document trees under docs/: the mermaid toolchain

# (node_modules) and its render cache, plus agent guidance (AGENTS.md and

# its CLAUDE.md symlink) which would otherwise be orphan documents.

exclude_patterns=[

"_build",

"node_modules",

"_mermaid_cache",

"AGENTS.md",

"CLAUDE.md",

],

)

globals().update(conf)