dev: add changelog.rst + rst: how to make links

itpp-labs · Mar 18, 2016 · 7a028b2 · 7a028b2
1 parent 1aeed22
commit 7a028b2
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 0 deletions.
diff --git a/docs/dev/__openerp__.py.rst b/docs/dev/__openerp__.py.rst
@@ -55,6 +55,8 @@ See also:
 version
 -------
 
+*Note: whenever you change version, you have to add a record in* :doc:`changelog.rst <changelog.rst>`
+
 The `x.y.z` version numbers follow the semantics `breaking.feature.fix`:
 
   * `x` increments when the data model or the views had significant

diff --git a/docs/dev/changelog.rst.rst b/docs/dev/changelog.rst.rst
@@ -0,0 +1,30 @@
+changelog.rst
+=============
+
+changelog.rst is located in ``doc/`` directory of a module. 
+
+Template
+---------
+
+.. code-block:: rst
+
+    Changelog
+    =========
+    
+    `2.0.0`
+    -------
+    - ADD absolutely new way of ..
+
+    `1.2.0`
+    -------
+    - ADD new interface for ..
+
+    `1.0.1`
+    -------
+
+    - FIX issue about ...
+
+    `1.0.0`
+    -------
+    
+    - init version
diff --git a/docs/dev/index.rst b/docs/dev/index.rst
@@ -6,6 +6,7 @@ Development
 
    README.rst.rst           
    __openerp__.py
+   changelog.rst.rst
    py/index
    xml/index
    yml/index

diff --git a/docs/other/rst.rst b/docs/other/rst.rst
@@ -30,6 +30,17 @@ Lists
 * 1,2,3, ... - numerated 
 
 
+Links
+-----
+
+* internal link::
+
+  :doc:`Link Text<../relative/path/to/article>`
+
+* external link:: 
+
+  `Link Text <https://google.com/>`_
+
 More documentations
 -------------------