提交 2451d82d 编写于 作者: S sibo2rr

read the doc

上级 225e9bd8
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
from recommonmark.parser import CommonMarkParser
# -- Project information -----------------------------------------------------
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
project = 'paddleclas'
copyright = '2021, paddleclas'
author = 'paddleclas'
# The full version, including alpha/beta/rc tags
release = '2.3.0'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'zh_CN'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Configuration file for the Sphinx documentation builder. # Configuration file for the Sphinx documentation builder.
from recommonmark.parser import CommonMarkParser
import sphinx_rtd_theme
# #
# This file only contains a selection of the most common options. For a full # This file only contains a selection of the most common options. For a full
# list see the documentation: # list see the documentation:
...@@ -15,16 +13,27 @@ import sphinx_rtd_theme ...@@ -15,16 +13,27 @@ import sphinx_rtd_theme
# import os # import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
extensions = ['recommonmark'] import sphinx_rtd_theme
import sphinx_markdown_tables
import recommonmark
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
from recommonmark.parser import CommonMarkParser
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
extensions = [
'recommonmark',
'sphinx_markdown_tables'
]
project = 'paddleclas' project = 'paddleclas'
copyright = '2021, paddleclas' copyright = '2021, paddleclas'
author = 'paddleclas' author = 'paddleclas'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '2.3' release = '2.3.0'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
...@@ -32,7 +41,6 @@ release = '2.3' ...@@ -32,7 +41,6 @@ release = '2.3'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['recommonmark']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
...@@ -43,14 +51,11 @@ templates_path = ['_templates'] ...@@ -43,14 +51,11 @@ templates_path = ['_templates']
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = 'zh_CN' language = 'zh_CN'
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = []
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
...@@ -58,7 +63,6 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -58,7 +63,6 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
......
...@@ -4,5 +4,8 @@ ...@@ -4,5 +4,8 @@
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
function_intro.md product.md
logo.md
cartoon.md
more_demo.md more_demo.md
vehicle.md
...@@ -10,7 +10,6 @@ ...@@ -10,7 +10,6 @@
VisualDL.md VisualDL.md
versions.md versions.md
update_history.md update_history.md
more_demo.md
train_on_xpu.md train_on_xpu.md
transfer_learning.md transfer_learning.md
train_with_DALI.md train_with_DALI.md
...@@ -27,8 +27,8 @@ def file_name(file_dir): ...@@ -27,8 +27,8 @@ def file_name(file_dir):
for dir in temp: for dir in temp:
for root, dirs, files in os.walk(dir): for root, dirs, files in os.walk(dir):
print(root) #当前目录路径 print(root) #当前目录路径
if 'index.rst' in files:
files.remove('index.rst') files.remove('index.rst')
print(files) #当前路径下所有非目录子文件 print(files) #当前路径下所有非目录子文件
curDir = os.path.join(file_dir, dir) curDir = os.path.join(file_dir, dir)
filename = curDir + '/index.rst' filename = curDir + '/index.rst'
...@@ -61,5 +61,5 @@ def readfile(filename): ...@@ -61,5 +61,5 @@ def readfile(filename):
file_name('./') file_name('./')
# filename = './index.rst' #filename = './index.rst'
# readfile(filename) #readfile(filename)
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册