diff --git a/doc/source/codestyle.rst b/doc/source/codestyle.rst index 2a1326b8751a3cddf2428c9295114d876a5a50ae..11b2039b864842d648c7b759e74a5cea481a2fc5 100644 --- a/doc/source/codestyle.rst +++ b/doc/source/codestyle.rst @@ -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. diff --git a/doc/source/sphinxdoc.rst b/doc/source/sphinxdoc.rst index a387c53f80169696d78098e3ca6504f52b156647..fe05b9885e5c655a5b53303585a596470fe97e7e 100644 --- a/doc/source/sphinxdoc.rst +++ b/doc/source/sphinxdoc.rst @@ -1,4 +1,4 @@ -sphinx-based documentation +Sphinx-based documentation ========================== The sphinx homepage: