From 5c3ab0d0a68fbfc7e7f634bbdf5e2153801edf33 Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Tue, 7 Aug 2018 11:51:59 +0800 Subject: [PATCH] remove unuse files --- conf.py | 175 ------------------------------------------------------ hello.md | 3 - index.rst | 39 ------------ 3 files changed, 217 deletions(-) delete mode 100644 conf.py delete mode 100644 hello.md delete mode 100644 index.rst diff --git a/conf.py b/conf.py deleted file mode 100644 index 9a781049..00000000 --- a/conf.py +++ /dev/null @@ -1,175 +0,0 @@ -# -*- 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 - -# -- 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 = u'M5Stack' -copyright = u'2017 - 2018, M5Stack Inc' -author = u'M5Stack' - -# The short X.Y version -version = u'' -# The full version, including alpha/beta/rc tags -release = u'1.0.1' - - -# -- 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 = [ -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -from recommonmark.parser import CommonMarkParser -source_parsers = { - '.md': CommonMarkParser, -} -# 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 = 'en' - -# 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 = [] - -# 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. -# -import sphinx_rtd_theme -html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_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 = {} - -# 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'] - -# 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 = {} - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'M5Stackdoc' - - -# -- 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, 'M5Stack.tex', u'M5Stack Documentation', - u'M5Stack', '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, 'm5stack', u'M5Stack 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, 'M5Stack', u'M5Stack Documentation', - author, 'M5Stack', 'One line description of project.', - 'Miscellaneous'), -] - -# -- AutoStructify Setting ---------------------------------------------- - -# At top on conf.py (with other import statements) -import recommonmark -from recommonmark.transform import AutoStructify - -# At the bottom of conf.py -def setup(app): - app.add_config_value('recommonmark_config', { - 'url_resolver': lambda url: github_doc_root + url, - # 'auto_toc_tree_section': 'Contents', - }, True) - app.add_transform(AutoStructify) diff --git a/hello.md b/hello.md deleted file mode 100644 index 6d774529..00000000 --- a/hello.md +++ /dev/null @@ -1,3 +0,0 @@ -## hello world - -### test markdown diff --git a/index.rst b/index.rst deleted file mode 100644 index c7b048f9..00000000 --- a/index.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. M5Stack documentation master file, created by - sphinx-quickstart on Sat Jul 21 01:10:30 2018. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -M5Stack's Documents -========================= - - -The documentation has different language versions. However, please refer to the English version if there is any discrepancy. - -================== ================== ================== -|Get Started|_ |API Reference|_ |M5Stack-cookbook|_ -================== ================== ================== - -.. |Get Started| image:: ../_static/get-started.gif -.. _Get Started: get-started/index.html - - -.. toctree:: - :hidden: - - Get Started - API Reference - M5Stack Awesome - API Guides - Contribute - Resources - Copyrights - About - [语言/Languages] - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` -