codestyle.rst

Numpydoc
========

More specifically,

- PEP 7 – Style Guide for C Code: https://peps.python.org/pep-0007/
- PEP 8 – Style Guide for Python Code: https://peps.python.org/pep-0008/



Numpydoc style, conf https://numpydoc.readthedocs.io/en/latest/format.html


Markup language
===============

标记语言(Markup language) 可以分为三类

    - 展示标记(Presentational markup)
        what you see is what you get
    - 步骤标记(Procedural markup)
        e.g., Markdown, TeX
    - 描述标记(Descriptive markup)
        e.g., LaTex, HTML, XML, ...

我们着重介绍两种在Python编程中被广泛运用的标记语言——Markdown和reStructured Text。

    1. Markdown
        Markdown可能是最轻量级的可用于层次化展示的标记语言，
        用户只需要学习为数不多的规则即可开始使用，
        并且在github等各种环境中均有插件支持。
        通常可以使用Markdown格式编写程序说明(`README.md`)
    2. reStructured Text



- reStructured Text
    https://www.writethedocs.org/guide/writing/reStructuredText/
-