FilesExpand file tree

main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

81 lines (81 loc) · 2.26 KB

main

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

81 lines (81 loc) · 2.26 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

73

74

75

76

77

78

79

80

81

# Set strict to true to turn warnings into errors to catch warnings within CI.

strict: true

theme:

name: material

# By default, fonts are pulled from Google on the Internet. To support offline usage, this is

# disabled.

font: false

palette:

scheme: slate

primary: green

accent: yellow

icon:

logo: material/math-integral-box

# GitHub specific.

repo: fontawesome/brands/github

favicon: static/math-integral-box.png

features:

- content.code.annotate

- content.code.copy

- content.tabs.link

- navigation.expand

- navigation.instant

- navigation.footer

- navigation.top

- navigation.tracking

- search.highlight

- search.share

- search.suggest

- toc.follow

markdown_extensions:

- admonition

- footnotes

- pymdownx.details

- pymdownx.keys

- pymdownx.highlight

- pymdownx.superfences

- pymdownx.snippets

- pymdownx.tabbed:

alternate_style: true

- md_in_html

extra_css:

- static/stylesheets/extra.css

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/johnthagen/python-blueprint

plugins:

- search

- offline:

enabled: !ENV [MKDOCS_MATERIAL_OFFLINE, false]

- mkdocstrings:

handlers:

python:

options:

show_if_no_docstring: true

show_signature_annotations: true

# Autodoc configuration.

# https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages

- gen-files:

scripts:

- docs/gen_ref_pages.py

- literate-nav:

nav_file: SUMMARY.md

# This plugin is used to validate URLs (including anchors).

- htmlproofer:

# This is not enabled by default because this requires network I/O, so it is inherently not

# exactly reproducible. For larger projects, this can also slow local build times.

validate_external_urls: !ENV [HTMLPROOFER_VALIDATE_EXTERNAL_URLS, false]

raise_error: True

watch:

# Watch src/ directory to reload on changes to docstrings for mkdocstrings plugin.

- src

site_name: fact

copyright: Copyright © 2018-2023 John Hagen

# GitHub Specific Configuration.

repo_name: python-blueprint

repo_url: https://github.com/johnthagen/python-blueprint

edit_uri: edit/main/docs/user_guide/docs/

nav:

- index.md

- Code Reference: reference/