From f0cba523df085960df8c0168a45e98ee0ca7e9e9 Mon Sep 17 00:00:00 2001 From: Anthony Scemama Date: Fri, 4 Apr 2014 00:47:13 +0200 Subject: [PATCH] Auto insert HTTP links to other modules in the README.rst file. --- scripts/update_README.py | 7 +++++-- src/AOs/README.rst | 6 +++--- src/Bitmask/README.rst | 12 ++++++------ src/Electrons/README.rst | 2 +- src/MOs/README.rst | 8 ++++---- src/Nuclei/README.rst | 4 ++-- src/Output/README.rst | 2 ++ src/README.rst | 16 ++++++++-------- src/Utils/README.rst | 2 ++ 9 files changed, 33 insertions(+), 26 deletions(-) diff --git a/scripts/update_README.py b/scripts/update_README.py index cb4f65aa..00e038b7 100755 --- a/scripts/update_README.py +++ b/scripts/update_README.py @@ -9,6 +9,7 @@ README="README.rst" Assum_key="Assumptions\n===========\n" Needed_key="Needed Modules\n==============\n" Sentinel="@@$%&@@" +URL="http://github.com/LCPQ/quantum_package/tree/master/src/" def fetch_splitted_data(): @@ -66,7 +67,8 @@ def update_assumptions(data): def update_needed(data): - """Read the NEEDED_MODULES file, and replace the data with it.""" + """Read the NEEDED_MODULES file, and replace the data with it. + Create the links to the GitHub pages.""" file = open('NEEDED_MODULES','r') modules = file.read() @@ -78,7 +80,8 @@ def update_needed(data): """ if modules.strip() != "": - modules = "\n".join(map(lambda x: '* %s'%(x), modules.split())) + modules = [ '* `%s <%s%s>`_'%(x,URL,x) for x in modules.split() ] + modules = "\n".join(modules) modules = Needed_key + header + modules + '\n\n' has_modules = False diff --git a/src/AOs/README.rst b/src/AOs/README.rst index 06be30d7..d63605d0 100644 --- a/src/AOs/README.rst +++ b/src/AOs/README.rst @@ -8,7 +8,7 @@ Needed Modules .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. -* Ezfio_files -* Nuclei -* Utils +* `Ezfio_files `_ +* `Nuclei `_ +* `Utils `_ diff --git a/src/Bitmask/README.rst b/src/Bitmask/README.rst index a382d542..7cfcb9ed 100644 --- a/src/Bitmask/README.rst +++ b/src/Bitmask/README.rst @@ -9,10 +9,10 @@ Needed Modules .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. -* AOs -* Electrons -* Ezfio_files -* MOs -* Nuclei -* Utils +* `AOs `_ +* `Electrons `_ +* `Ezfio_files `_ +* `MOs `_ +* `Nuclei `_ +* `Utils `_ diff --git a/src/Electrons/README.rst b/src/Electrons/README.rst index 509e5874..bf4682cb 100644 --- a/src/Electrons/README.rst +++ b/src/Electrons/README.rst @@ -24,5 +24,5 @@ Needed Modules .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. -* Ezfio_files +* `Ezfio_files `_ diff --git a/src/MOs/README.rst b/src/MOs/README.rst index ce89fced..bcbf0d95 100644 --- a/src/MOs/README.rst +++ b/src/MOs/README.rst @@ -8,8 +8,8 @@ Needed Modules .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. -* AOs -* Ezfio_files -* Nuclei -* Utils +* `AOs `_ +* `Ezfio_files `_ +* `Nuclei `_ +* `Utils `_ diff --git a/src/Nuclei/README.rst b/src/Nuclei/README.rst index 5e6c66de..b7b49b6a 100644 --- a/src/Nuclei/README.rst +++ b/src/Nuclei/README.rst @@ -8,6 +8,6 @@ Needed Modules .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. -* Ezfio_files -* Utils +* `Ezfio_files `_ +* `Utils `_ diff --git a/src/Output/README.rst b/src/Output/README.rst index 736449bf..289754d3 100644 --- a/src/Output/README.rst +++ b/src/Output/README.rst @@ -6,3 +6,5 @@ Output Module + + diff --git a/src/README.rst b/src/README.rst index a6d93fe1..5cdd78ad 100644 --- a/src/README.rst +++ b/src/README.rst @@ -109,12 +109,12 @@ Needed Modules .. Do not edit this section. It was auto-generated from the .. NEEDED_MODULES file. -* AOs -* Bitmask -* Electrons -* Ezfio_files -* MOs -* Nuclei -* Output -* Utils +* `AOs `_ +* `Bitmask `_ +* `Electrons `_ +* `Ezfio_files `_ +* `MOs `_ +* `Nuclei `_ +* `Output `_ +* `Utils `_ diff --git a/src/Utils/README.rst b/src/Utils/README.rst index 825a6599..d3dc4898 100644 --- a/src/Utils/README.rst +++ b/src/Utils/README.rst @@ -20,3 +20,5 @@ Needed Modules + +