diff options
| author |   Yujun Zhang <zhang.yujunz@zte.com.cn> | 2016-11-01 20:19:56 +0800 |
|---|---|---|
| committer | Yujun Zhang <zhang.yujunz@zte.com.cn> | 2016-11-01 20:19:56 +0800 |
| commit | 82efecc12af0f0ebf108aac9bccb83936ecbd7cd (patch) | |
| tree | 7eb47bf94aae8bd0154b82e28aa520d250316946 /CONTRIBUTING.rst | |
| parent | 356e73b6a3f47669e907cb5e54494d4bb1163330 (diff) | |
Normalize headings according to "reStructuredText Primer"
[1]: http://www.sphinx-doc.org/en/stable/rest.html
Change-Id: Ie7530846e0b3683118422ed6ce24e0cd5af94a6e
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d3e21b80..6350a862 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -56,6 +56,22 @@ Specially, it is recommended to link each patch set with a JIRA issue. Put in commit message to create an automatic link. +************* +Documentation +************* + +The documents are built automatically by sphinx from reStructuredText (reST). +Please read `reStructuredText Primer`_ 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 + ************************ Frequent Asked Questions ************************ @@ -76,4 +92,5 @@ to submit. The current members are listed in `INFO`_. .. _OPNFV Releases: https://wiki.opnfv.org/display/SWREL .. _Issue Types: https://jira.opnfv.org/secure/ShowConstantsHelp.jspa?decorator=popup#IssueTypes .. _OpenStack Style Guidelines: http://docs.openstack.org/developer/hacking/ -.. _INFO: https://git.opnfv.org/cgit/qtip/tree/INFO
\ No newline at end of file +.. _INFO: https://git.opnfv.org/cgit/qtip/tree/INFO +.. _reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.html |