Skip to content

Commit 97f2caf

Browse files
committed
docs: Add accidentally deleted files
1 parent 477b9cc commit 97f2caf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+5406
-1
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# from the environment for the first two.
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
8-
SOURCEDIR = en
8+
SOURCEDIR = zh_CN
99
BUILDDIR = build/$(SOURCEDIR)
1010

1111
# Put it first so that "make" without argument is like "make help".

docs/en/COPYRIGHT.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
COPYRIGHT
2+
==========

docs/en/conf.py

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
# import os
14+
# import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
16+
import subprocess, os
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
import datetime
21+
current_year = datetime.datetime.now().year
22+
23+
project = 'UIFlow2 Programming Guide'
24+
copyright = '2016 - {} M5Stack Technology Co., Ltd'.format(current_year)
25+
author = 'pandian'
26+
27+
# The full version, including alpha/beta/rc tags
28+
release = 'master'
29+
30+
31+
# -- General configuration ---------------------------------------------------
32+
33+
# Add any Sphinx extension module names here, as strings. They can be
34+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35+
# ones.
36+
extensions = [
37+
'breathe',
38+
'recommonmark',
39+
'sphinx_markdown_tables',
40+
'nbsphinx',
41+
'sphinx_copybutton',
42+
]
43+
44+
# Add any paths that contain templates here, relative to this directory.
45+
templates_path = ['_templates']
46+
47+
# List of patterns, relative to source directory, that match files and
48+
# directories to ignore when looking for source files.
49+
# This pattern also affects html_static_path and html_extra_path.
50+
exclude_patterns = []
51+
52+
53+
# -- Options for HTML output -------------------------------------------------
54+
55+
# The theme to use for HTML and HTML Help pages. See the documentation for
56+
# a list of builtin themes.
57+
#
58+
html_theme = 'sphinx_rtd_theme'
59+
60+
# Add any paths that contain custom static files (such as style sheets) here,
61+
# relative to this directory. They are copied after the builtin static files,
62+
# so a file named "default.css" will overwrite the builtin "default.css".
63+
html_static_path = ['../_static']
64+
65+
breathe_projects = { "zbhci": "../build/xml/" }
66+
67+
breathe_default_project = "zbhci"
68+
69+
breathe_domain_by_extension = {
70+
"h" : "c",
71+
"c" : "c",
72+
}
73+
74+
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
75+
76+
77+
if read_the_docs_build:
78+
79+
subprocess.call('cd ../; doxygen', shell=True)

docs/en/controllers/atoms3-lite.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
AtomS3 Lite
2+
===========

docs/en/controllers/atoms3.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
AtomS3
2+
======

docs/en/controllers/atoms3u.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
AtomS3U
2+
=======

docs/en/controllers/cores3.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
CoreS3
2+
======

docs/en/controllers/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Controllers
2+
============
3+
4+
.. toctree::
5+
6+
cores3.rst
7+
atoms3.rst
8+
atoms3-lite.rst
9+
atoms3u.rst
10+
stamps3.rst

docs/en/controllers/stamps3.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
StampS3
2+
=======

docs/en/get-started/index.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Get Started
2+
============
3+
4+
Currently UIFLOW2 supports the following boards:
5+
6+
================== ================== ==================
7+
|AtomS3|_ |AtomS3 Lite|_ |AtomS3U|_
8+
------------------ ------------------ ------------------
9+
`AtomS3`_ `AtomS3 Lite`_ `AtomS3U`_
10+
------------------ ------------------ ------------------
11+
|StampS3|_ |CoreS3|_ |Core2|_
12+
------------------ ------------------ ------------------
13+
`StampS3`_ `CoreS3`_ `Core2`_
14+
------------------ ------------------ ------------------
15+
|TOUGH|_
16+
------------------ ------------------ ------------------
17+
`TOUGH`_
18+
================== ================== ==================
19+
20+
.. |AtomS3| image:: https://static-cdn.m5stack.com/resource/docs/products/core/AtomS3/img-ee8b91d5-f96a-4605-bd05-420ecde256c4.webp
21+
.. _AtomS3: https://docs.m5stack.com/zh_CN/core/AtomS3
22+
23+
.. |AtomS3 Lite| image:: https://static-cdn.m5stack.com/resource/docs/products/core/AtomS3%20Lite/img-dc6432b6-fd9b-4066-9a4d-49786503d1a3.webp
24+
.. _AtomS3 Lite: https://docs.m5stack.com/zh_CN/core/AtomS3%20Lite
25+
26+
.. |AtomS3U| image:: https://static-cdn.m5stack.com/resource/docs/products/core/AtomS3U/img-82d5d251-1bfd-4133-9324-404242e5acc7.webp
27+
.. _AtomS3U: https://docs.m5stack.com/zh_CN/core/AtomS3U
28+
29+
.. |StampS3| image:: https://static-cdn.m5stack.com/resource/docs/products/core/StampS3/img-964c4df6-26ff-49e0-9950-87ee1a0f3b18.webp
30+
.. _StampS3: https://docs.m5stack.com/zh_CN/core/StampS3
31+
32+
.. |CoreS3| image:: https://static-cdn.m5stack.com/resource/docs/products/core/CoreS3/img-96063e2a-637a-4d11-ac47-1ce4f1cdfd3e.webp
33+
.. _CoreS3: https://docs.m5stack.com/zh_CN/core/CoreS3
34+
35+
.. |Core2| image:: https://static-cdn.m5stack.com/resource/docs/products/core/core2/core2_01.webp
36+
.. _Core2: https://docs.m5stack.com/zh_CN/core/core2
37+
38+
.. |TOUGH| image:: https://static-cdn.m5stack.com/resource/docs/products/core/tough/tough_01.webp
39+
.. _TOUGH: https://docs.m5stack.com/zh_CN/core/tough
40+

0 commit comments

Comments
 (0)