[image: 986.png] I tried indenting to 0 or 1 or 2 or 3 or 4 spaces, none of which worked.
Is there anything in particular to be aware of? -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/7bb4271a-1d55-4518-a547-64b353b99f93n%40googlegroups.com.
# -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/master/config import sphinx_rtd_theme # import sphinx_bootstrap_theme #def setup(app): # app.add_css_file('ycp.css') # -- 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('.')) # -- Project information ----------------------------------------------------- project = '驿窗项目' copyright = ': 驿窗' author = '驿窗' # The short X.Y version version = '开源/Linux大众化，从驿窗开始' # The full version, including alpha/beta/rc tags release = '' # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ "sphinx.ext.ifconfig", "sphinx.ext.todo", "sphinx_rtd_theme", # 'sphinxcontrib.fulltoc', #(驿窗注：这里可以确定是否在侧栏显示完整目录，前提是已经pip install sphinxcontrib.fulltoc) ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # 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 = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # -- 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 = "sphinx_rtd_theme" # html_theme = "bootstrap" # html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = { # 'stickysidebar': 'true', #(驿窗注：bizstyle不支持此选项) # 'sidebarbgcolor': '#ff5c4a', # 'sidebarlinkcolor': '#000000', # 'sidebarwidth': '500', # 'style_nav_header_background': '#004400', # 'sidebartextcolor': '#ff5c4a', # 'stickysidebarscrollable': True, 'display_version': True, 'navigation_depth': 1, 'prev_next_buttons_location': 'both', } # 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_last_updated_fmt = '%Y年%m月%d日 %H:%M' #上面一行的时间记录可用，但需要清理rst文件中的尾部手动写入的时间记录。 #onlyifchanged = True #上面一行表示只对改动过的rst文件创建html，未改动的rst不创建新文件。此参数需要下面的命令配合：make html -a html_copy_source = False #在_build/html目录包括rst源文件 html_static_path = ['_static'] html_use_index = False html_show_sphinx = False html_title = '' html_style = 'css/theme-ycp.css' #覆盖默认sphinx-rtd-theme的css效果。 html_logo = 'img/avatarp.svg' html_favicon = 'img/avatarp.ico' html_domain_indices = False html_use_opensearch = 'False' html_show_sourcelink = False html_css_files = [ 'css/s4defs-roles.css', 'css/underline.css', ] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # html_sidebars = { '**': ['localtoc.html', 'relations.html', 'searchbox.html'] } # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = 'ycpsitedoc' # -- Options for LaTeX output ------------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'ycpsite.tex', 'ycpsite Documentation', '驿窗', 'manual'), ] # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'ycpsite', 'ycpsite Documentation', [author], 1) ] # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'ycpsite', 'ycpsite Documentation', author, 'ycpsite', 'One line description of project.', 'Miscellaneous'), ] rst_prolog = """ .. include:: <s5defs.txt> .. default-role:: """ # -- Extension configuration ------------------------------------------------- todo_include_todos = True
.. _test2: test2 ============================= dumping search index in Chinese： * copying static files1 * copying static files2 * copying static files3
