GitHub-Mirror/bl_mcu_sdk
2
0
Fork 0
mirror of https://github.com/Fishwaldo/bl_mcu_sdk.git synced 2025-07-12 07:48:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[doc] update readme and rst

Browse source
This commit is contained in:
jzlv 2022-12-07 10:19:27 +08:00
parent 3f480f087b
commit 4cdef3164f
65 changed files with 2435 additions and 640 deletions
Download patch file Download diff file Expand all files Collapse all files

148
docs/source/conf.py
View file

@ -1,74 +1,74 @@
# Configuration file for the Sphinx documentation builder.
# -- Project information
project = 'CherryUSB'
copyright = '2022, sakumisu'
author = 'sakumisu'
release = '0.4'
version = '0.4.0'
# -- General configuration
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'recommonmark',
'sphinx_markdown_tables'
]
intersphinx_mapping = {
# 'python': ('https://docs.python.org/3/', None),
# 'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
templates_path = ['_templates']
# -- Options for HTML output
html_theme = 'sphinx_rtd_theme'
# -- Options for EPUB output
epub_show_urls = 'footnote'
# Configuration file for the Sphinx documentation builder.
# -- Project information
project = 'BL_MCU_SDK'
copyright = '2022, Bouffalolab Team'
author = 'Bouffalolab Team'
release = '0.1'
version = '0.1.0'
# -- General configuration
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'recommonmark',
'sphinx_markdown_tables'
]
intersphinx_mapping = {
# 'python': ('https://docs.python.org/3/', None),
# 'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
templates_path = ['_templates']
# -- Options for HTML output
html_theme = 'sphinx_rtd_theme'
# -- Options for EPUB output
epub_show_urls = 'footnote'
# Configuration file for the Sphinx documentation builder.
# -- Project information
project = 'CherryUSB'
copyright = '2022, sakumisu'
author = 'sakumisu'
release = '0.4'
version = '0.4.0'
# -- General configuration
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'recommonmark',
'sphinx_markdown_tables'
]
intersphinx_mapping = {
# 'python': ('https://docs.python.org/3/', None),
# 'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
templates_path = ['_templates']
# -- Options for HTML output
html_theme = 'sphinx_rtd_theme'
# -- Options for EPUB output
epub_show_urls = 'footnote'
# Configuration file for the Sphinx documentation builder.
# -- Project information
project = 'BL_MCU_SDK'
copyright = '2022, Bouffalolab Team'
author = 'Bouffalolab Team'
release = '0.1'
version = '0.1.0'
# -- General configuration
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'recommonmark',
'sphinx_markdown_tables'
]
intersphinx_mapping = {
# 'python': ('https://docs.python.org/3/', None),
# 'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']
templates_path = ['_templates']
# -- Options for HTML output
html_theme = 'sphinx_rtd_theme'
# -- Options for EPUB output
epub_show_urls = 'footnote'