From 085ed6d24d060a1d6ab36e1c5ee34b89e772ba2f Mon Sep 17 00:00:00 2001 From: Luke Pratley Date: Fri, 1 Feb 2019 13:38:30 +0000 Subject: [PATCH 1/4] Update CONTRIBUTORS.md --- cpp/docs/CONTRIBUTORS.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/cpp/docs/CONTRIBUTORS.md b/cpp/docs/CONTRIBUTORS.md index 28f8b2f4b..8defaf34a 100644 --- a/cpp/docs/CONTRIBUTORS.md +++ b/cpp/docs/CONTRIBUTORS.md @@ -30,12 +30,6 @@ Dr. Roland Guichard
[website](https://github.com/UCLGuichard) -![](photo_vijay.jpg) -
-Dr. Vijay Kartik
-[website](https://people.epfl.ch/vijay.kartik) -
- ![](photo_jason.jpg)
Dr. Jason D. McEwen
From 8ebb6432d2f3237446de88ce2363cd56c791fd90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20P=C3=A9rez-Su=C3=A1rez?= Date: Fri, 1 Feb 2019 14:18:59 +0000 Subject: [PATCH 2/4] [doc] Update links to contributors --- README.md | 2 +- cpp/docs/{CONTRIBUTORS.md => SOPT_CONTRIBUTORS.md} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename cpp/docs/{CONTRIBUTORS.md => SOPT_CONTRIBUTORS.md} (97%) diff --git a/README.md b/README.md index 7ef3cc2f2..b83771130 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ See `matlab/README.txt` for an overview of the Matlab implementation. The stand- Contributors ------------ -Check the [contributors](@ref contributors) page ([github](cpp/docs/CONTRIBUTORS.md)). +Check the [contributors](@ref sopt_contributors) page ([github](cpp/docs/SOPT_CONTRIBUTORS.md)). References and citation ----------------------- diff --git a/cpp/docs/CONTRIBUTORS.md b/cpp/docs/SOPT_CONTRIBUTORS.md similarity index 97% rename from cpp/docs/CONTRIBUTORS.md rename to cpp/docs/SOPT_CONTRIBUTORS.md index 8defaf34a..699987c2b 100644 --- a/cpp/docs/CONTRIBUTORS.md +++ b/cpp/docs/SOPT_CONTRIBUTORS.md @@ -1,4 +1,4 @@ -Contributors {#contributors} +Contributors {#sopt_contributors} ---------------------------------- **SOPT** was initially created by Rafael Carrillo, Jason McEwen and Yves Wiaux but major contributions From 230e97f206122d56737abace13171309522ddf5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20P=C3=A9rez-Su=C3=A1rez?= Date: Fri, 1 Feb 2019 14:25:30 +0000 Subject: [PATCH 3/4] [doc] bullet list for webpages --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b83771130..853e3a6dd 100644 --- a/README.md +++ b/README.md @@ -153,8 +153,8 @@ License Webpage ------- -[documentation](http://astro-informatics.github.io/sopt) -[repository](https://github.com/astro-informatics/sopt) +- [Documentation](http://astro-informatics.github.io/sopt) +- [Repository](https://github.com/astro-informatics/sopt) Support ------- From 8fa333afcc217933db63bc2ca46948255c21d454 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20P=C3=A9rez-Su=C3=A1rez?= Date: Fri, 1 Feb 2019 14:42:31 +0000 Subject: [PATCH 4/4] [doc] Add a doxygen layout file to remove Related Pages The related pages has only one page: Contributors. It doesn't make much sense to keep a full tab for a single page. --- cpp/docs/CMakeLists.txt | 6 ++ cpp/docs/DoxygenLayout.xml | 194 +++++++++++++++++++++++++++++++++++++ 2 files changed, 200 insertions(+) create mode 100644 cpp/docs/DoxygenLayout.xml diff --git a/cpp/docs/CMakeLists.txt b/cpp/docs/CMakeLists.txt index 467e1ca74..a3da53998 100644 --- a/cpp/docs/CMakeLists.txt +++ b/cpp/docs/CMakeLists.txt @@ -8,6 +8,12 @@ configure_file( ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ) +file(COPY + ${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml + DESTINATION ${CMAKE_CURRENT_BINARY_DIR} +) + + add_custom_target(doc ALL COMMAND doxygen WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) diff --git a/cpp/docs/DoxygenLayout.xml b/cpp/docs/DoxygenLayout.xml new file mode 100644 index 000000000..400ec49f7 --- /dev/null +++ b/cpp/docs/DoxygenLayout.xml @@ -0,0 +1,194 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +