From 82cc809698b3b52327a0360eea10b88aacbadec6 Mon Sep 17 00:00:00 2001 From: BO ZHANG Date: Fri, 7 Oct 2022 17:08:14 +0800 Subject: [PATCH] tweaks --- doc/source/codestyle.rst | 4 ++-- doc/source/sphinxdoc.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/codestyle.rst b/doc/source/codestyle.rst index 2a1326b..11b2039 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 a387c53..fe05b98 100644 --- a/doc/source/sphinxdoc.rst +++ b/doc/source/sphinxdoc.rst @@ -1,4 +1,4 @@ -sphinx-based documentation +Sphinx-based documentation ========================== The sphinx homepage: -- GitLab