From 0707ddf4c26fefe85d8036c767321e9b2d379fb5 Mon Sep 17 00:00:00 2001 From: Aaron LI Date: Fri, 25 Nov 2016 10:59:56 +0800 Subject: README.rst: Add hyper links with nested inline markups Workaround for nested inline markups: http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible https://stackoverflow.com/a/4836544/4856091 --- README.rst | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index e1274cf..643137c 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,4 @@ +============================================================== Realistic Foregrounds Simulation for EoR 21cm Signal Detection ============================================================== @@ -8,8 +9,8 @@ It is *NOT* recommended to use it at the moment! Nevertheless, *tests and feedback* are always welcome! -This package provides the tools to simulate the *realistic* -low-frequency radio foregrounds, which can be further +This |fg21sim|_ package provides the tools to simulate the +*realistic* low-frequency radio foregrounds, which can be further used to test various foreground removal or separation methods, for the purpose of successfully detecting the 21cm cosmological signal arising from the netrual hydrogen (HI) at epoch of reionization (EoR). @@ -22,7 +23,7 @@ Requirements Contributions ------------- -Great! Be sure to consult the guidelines in ``CONTRIBUTING.md``. +Great! Be sure to consult the guidelines in |CONTRIBUTING.md|_. Authors @@ -43,8 +44,22 @@ Unless otherwise declared: - Documentations and products generated by us are distributed under the `Creative Commons Attribution 3.0 License`_; - Third-party codes and products used are distributed under their own - licenses. See also ``LICENSE-3RDPARTY``. - - + licenses. See also |LICENSE-3RDPARTY|_. + + +.. + Workaround for nested inline markups: + http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible + https://stackoverflow.com/a/4836544/4856091 + +.. |fg21sim| replace:: **fg21sim** +.. _fg21sim: https://github.com/liweitianux/fg21sim +.. |CONTRIBUTING.md| replace:: ``CONTRIBUTING.md`` +.. _CONTRIBUTING.md: + https://github.com/liweitianux/fg21sim/blob/master/CONTRIBUTING.md +.. |LICENSE-3RDPARTY| replace:: ``LICENSE-3RDPARTY`` +.. _LICENSE-3RDPARTY: + https://github.com/liweitianux/fg21sim/blob/master/LICENSE-3RDPARTY .. _`MIT License`: https://opensource.org/licenses/MIT -.. _`Creative Commons Attribution 3.0 License`: https://creativecommons.org/licenses/by/3.0/us/deed.en_US +.. _`Creative Commons Attribution 3.0 License`: + https://creativecommons.org/licenses/by/3.0/us/deed.en_US -- cgit v1.2.2