Skip to content

Commit f8b1eee

Browse files
committed
fix(doc): revert sphinx & correct notfound
1 parent 4afa6c9 commit f8b1eee

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ breathe==4.36.0
22
exhale==0.3.7
33
myst-parser==4.0.1
44
myst-parser[linkify]
5-
sphinx==9.0.1
5+
sphinx==8.3.0
66
sphinx-notfound-page==1.1.0

doc/src/conf.py

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@
1616
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
1717

1818
project = 'RFID_MFRC522v2'
19-
copyright = '2023, GithubCommunity'
19+
project_copyright = '%Y, GithubCommunity'
2020
author = 'GithubCommunity'
2121

2222
# -- General configuration ---------------------------------------------------
2323
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2424

2525
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',
3737
]
3838

3939
templates_path = ['_templates']
@@ -43,9 +43,9 @@
4343
pygments_style = 'sphinx'
4444

4545
source_suffix = {
46-
'.rst': 'restructuredtext',
47-
'.txt': 'literal',
48-
'.md': 'markdown',
46+
'.rst': 'restructuredtext',
47+
'.txt': 'literal',
48+
'.md': 'markdown',
4949
}
5050

5151
# If this is not None, a ‘Last updated on:’ timestamp is inserted at every page bottom.
@@ -54,33 +54,33 @@
5454
# -- Options for HTML output -------------------------------------------------
5555
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
5656

57-
#html_theme = 'alabaster'
5857
html_theme = 'nature'
5958
html_static_path = ['_static']
6059

6160
### Custom plugins ###
6261
## Markdown
6362
myst_enable_extensions = [
64-
"linkify",
65-
"smartquotes",
66-
"strikethrough",
67-
"tasklist",
63+
'linkify',
64+
'smartquotes',
65+
'strikethrough',
66+
'tasklist',
6867
]
6968
## Bridge doxygen <> sphinx.
7069
breathe_projects = {
71-
'MFRC522': "./_doxygen/xml/"
70+
'MFRC522': './_doxygen/xml/'
7271
}
7372
breathe_default_project = 'MFRC522'
7473
breathe_default_members = (
75-
'members',
76-
# 'undoc-members',
74+
'members',
75+
# 'undoc-members',
7776
)
78-
## Auto generate doc for every cpp-file.
77+
## Auto generate doc for every cpp-file.
7978
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,
8584
}
86-
85+
## notfound
86+
notfound_urls_prefix = '/Arduino_MFRC522v2/'

0 commit comments

Comments
 (0)