Commit 82cc8096 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

tweaks

parent eef772a2
Loading
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
@@ -84,8 +84,8 @@ For example,
    python -m numpydoc --validate csst_proto.top_level_interface.flip_image


Markup language
===============
Markup languages
================
Markdown and reStructrured Text are two of popular markup languages.
reStructrured Text is used in Numpydoc docstrings as well as sphinx-based documentation.
Markdown is much easier and usually used to write `README` for a package.
+1 −1
Original line number Diff line number Diff line
sphinx-based documentation
Sphinx-based documentation
==========================

The sphinx homepage: