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

tweaks

parent eef772a2
Pipeline #182 passed with stages
in 15 seconds
......@@ -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.
......
sphinx-based documentation
Sphinx-based documentation
==========================
The sphinx homepage:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment