diff options
| author |   Yujun Zhang <zhang.yujunz@zte.com.cn> | 2017-04-02 09:05:46 +0800 |
|---|---|---|
| committer | Yujun Zhang <zhang.yujunz@zte.com.cn> | 2017-04-02 09:05:46 +0800 |
| commit | 8ed573c27d67bdc7bead88e960f23bdb5f0f88b0 (patch) | |
| tree | 789800d771dfc8ef705836618bb0e42314fadb8c /CONTRIBUTING.md | |
| parent | 9e4d243f1360158555fe92cc35fae6521bfdfce5 (diff) | |
Add more comprehensive document example
Change-Id: Ia414c692c7f91c4e071cdb4fb19637eb10adf11c
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 1 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03420986..9e73df14 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,14 +98,7 @@ Documentation The documents are built automatically by sphinx from reStructuredText (reST). Please read [reStructuredText Primer][rp] if you are not familiar with it. -A cheat sheet for headings are as following - -* `#` with overline, for parts -* `*` with overline, for chapters -* `=`, for sections -* `-`, for subsections -* `^`, for subsubsections -* `"`, for paragraphs +Start a new document by copying an example from ``docs/example`` Frequent Asked Questions ------------------------ |