@@ -98,7 +98,7 @@ the index.html can be opened to see a skeleton project documentation::
c02xd1g9jgh7:tsi-ccdoc davidyuan$ open build/html/index.html
using markdown with sphinx
Using markdown with sphinx
--------------------------
the restructuredtext is powerful but its syntax is also a bit overwhelming. the markdown can be a alternative for simple documentation. the 'recommonmark' is needed to use markdown and restructuredtext in the same sphinx project.::
@@ -115,8 +115,8 @@ then, `conf.py` would also needs to be updated.::
source_suffix = ['.rst', '.md']
reference
Reference
---------
#. `restructuredtext primer <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
#. `getting started with sphinx <https://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html>`_
#. `Restructuredtext primer <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
#. `Getting started with sphinx <https://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html>`_