|
16 | 16 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
17 | 17 |
|
18 | 18 | project = 'RFID_MFRC522v2' |
19 | | -copyright = '2023, GithubCommunity' |
| 19 | +project_copyright = '%Y, GithubCommunity' |
20 | 20 | author = 'GithubCommunity' |
21 | 21 |
|
22 | 22 | # -- General configuration --------------------------------------------------- |
23 | 23 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
24 | 24 |
|
25 | 25 | extensions = [ |
26 | | - 'breathe', |
27 | | - "exhale", |
28 | | - 'myst_parser', |
29 | | - 'notfound.extension', |
30 | | - 'sphinx.ext.autodoc', |
31 | | - 'sphinx.ext.coverage', |
32 | | - 'sphinx.ext.githubpages', |
33 | | - 'sphinx.ext.ifconfig', |
34 | | - 'sphinx.ext.inheritance_diagram', |
35 | | - 'sphinx.ext.todo', |
36 | | - 'sphinx.ext.viewcode', |
| 26 | + 'breathe', |
| 27 | + 'exhale', |
| 28 | + 'myst_parser', |
| 29 | + 'notfound.extension', |
| 30 | + 'sphinx.ext.autodoc', |
| 31 | + 'sphinx.ext.coverage', |
| 32 | + 'sphinx.ext.githubpages', |
| 33 | + 'sphinx.ext.ifconfig', |
| 34 | + 'sphinx.ext.inheritance_diagram', |
| 35 | + 'sphinx.ext.todo', |
| 36 | + 'sphinx.ext.viewcode', |
37 | 37 | ] |
38 | 38 |
|
39 | 39 | templates_path = ['_templates'] |
|
43 | 43 | pygments_style = 'sphinx' |
44 | 44 |
|
45 | 45 | source_suffix = { |
46 | | - '.rst': 'restructuredtext', |
47 | | - '.txt': 'literal', |
48 | | - '.md': 'markdown', |
| 46 | + '.rst': 'restructuredtext', |
| 47 | + '.txt': 'literal', |
| 48 | + '.md': 'markdown', |
49 | 49 | } |
50 | 50 |
|
51 | 51 | # If this is not None, a ‘Last updated on:’ timestamp is inserted at every page bottom. |
|
54 | 54 | # -- Options for HTML output ------------------------------------------------- |
55 | 55 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
56 | 56 |
|
57 | | -#html_theme = 'alabaster' |
58 | 57 | html_theme = 'nature' |
59 | 58 | html_static_path = ['_static'] |
60 | 59 |
|
61 | 60 | ### Custom plugins ### |
62 | 61 | ## Markdown |
63 | 62 | myst_enable_extensions = [ |
64 | | - "linkify", |
65 | | - "smartquotes", |
66 | | - "strikethrough", |
67 | | - "tasklist", |
| 63 | + 'linkify', |
| 64 | + 'smartquotes', |
| 65 | + 'strikethrough', |
| 66 | + 'tasklist', |
68 | 67 | ] |
69 | 68 | ## Bridge doxygen <> sphinx. |
70 | 69 | breathe_projects = { |
71 | | - 'MFRC522': "./_doxygen/xml/" |
| 70 | + 'MFRC522': './_doxygen/xml/' |
72 | 71 | } |
73 | 72 | breathe_default_project = 'MFRC522' |
74 | 73 | breathe_default_members = ( |
75 | | - 'members', |
76 | | - # 'undoc-members', |
| 74 | + 'members', |
| 75 | + # 'undoc-members', |
77 | 76 | ) |
78 | | -## Auto generate doc for every cpp-file. |
| 77 | +## Auto generate doc for every cpp-file. |
79 | 78 | exhale_args = { |
80 | | - "containmentFolder": "./lib", |
81 | | - "doxygenStripFromPath": "..", |
82 | | - "rootFileName": "index.rst", |
83 | | - "rootFileTitle": "Library API", |
84 | | - # "createTreeView": True, |
| 79 | + 'containmentFolder': './lib', |
| 80 | + 'doxygenStripFromPath': '..', |
| 81 | + 'rootFileName': 'index.rst', |
| 82 | + 'rootFileTitle': 'Library API', |
| 83 | + # 'createTreeView': True, |
85 | 84 | } |
86 | | - |
| 85 | +## notfound |
| 86 | +notfound_urls_prefix = '/Arduino_MFRC522v2/' |
0 commit comments