Kivy 简明教程

Kivy - reStructuredText

reStructuredText 是一种文本文件格式，其中包含主要用于技术文档的 Python 中使用的数据。该文件通常具有“.rst”扩展名。

  1. reStructuredText 是 DocUtils 项目的一部分，其主要目的是为 Python 提供一组类似于 Java 中 Javadoc 的工具。由 David Goodger 编写，其最早版本于 2001 年发布，最新版本于 2019 年发布。

  2. reStructuredText 可被视为轻量级标记语言，与 MarkDown 语法有很多相似之处。它被用作 Python 的 Sphinx 文档生成系统的一个核心组件。

Kivy 提供了 RstDocument 类形式的 reStructuredText 文档渲染器，该类定义在“kivy.uix.rst”模块中。

from kivy.uix.rst import RstDocument
doc = RstDocument(**kwargs)

Formatting reStructuredText

  1. Paragraph − 由空行分隔的一段文本（一行就够了）。段落必须具有相同的缩进。

  2. Bold − 两个星号之间的字符（示例：你好）

  3. Italics − 单个星号之间的字符（示例： world ）

  4. Enumerated list − 以数字或字母开头，后跟一个句点“.”、右括号“)”或括在括号“( )”中开始一行。例如 −

1. Python
2. Java
3. C++

  1. Bulleted list − 以项目符号 -、+ 或 * 开头开始出行

  2. Sections − 这些是一行文本（一个或多个单词），带装饰：单独下划线或下划线和上划线一起，用短划线“-----”、等号“======"

  3. Images − 要在文档中包含图像，请使用图像指令。例如 −

.. image:: kivi-logo.png

Example

以下文本按照 reStructuredText 语法进行格式化。将以下文本另存为 index.rst −

================
Welcome to Kivy
================
Welcome to Kivy's documentation. **Kivy** is an open source software library for the rapid development of applications equipped with novel user interfaces, such as multi-touch apps.
With Kivy, you can create apps that run on:

* Desktop computers: macOS, Linux, *BSD Unix, Windows.
* iOS devices: iPad, iPhone.
* Android devices: tablets, phones.


-------------------
Virtual environment
-------------------
Create the virtual environment named kivy_venv in your current directory_::

   python -m virtualenv kivy_venv

Activate the *virtual environment*.

For Windows default CMD, in the command line do_::
   kivy_venv\Scripts\activate

Your terminal should now preface the path with something like (kivy_venv), indicating that the kivy_venv environment is active.
If it doesn't say that, the virtual environment is not active and the following won't work.

Install Kivy
------------
The simplest is to install the current stable version of kivy is to use pip_::

   python -m pip install "kivy[base]" kivy_examples

让我们编写一个程序在 Kivy 应用程序中渲染此 reStructuredText 文档。我们把一个 RstDocument 小组件放在一个仅有一列的网格布局中。将此对象的 source 属性设置为我们创建的 RST 文件。

from kivy.app import App
from kivy.uix.rst import RstDocument
from kivy.uix.gridlayout import GridLayout
from kivy.core.window import Window

Window.size = (720,400)

class rstdemoapp(App):
   def build(self):
      grid=GridLayout(cols=1)
      doc = RstDocument(source="index.rst")
      grid.add_widget(doc)
      return grid
rstdemoapp().run()

Output

运行以上代码。RST 文档将按照上面解释的格式化语法显示。

kivy restructured text