From bc4c0b9e414a30d3823163e9f60ec5d4081a92bf Mon Sep 17 00:00:00 2001 From: Vaibhav Patel Date: Tue, 12 Oct 2021 03:18:53 -0400 Subject: [PATCH 1/3] Add CONTRIBUTORS.rst and include in README_for_docs.rst Had to do this manually because all-contributors does not yet support rst. --- CONTRIBUTORS.rst | 23 +++++++++++++++++++++++ README_for_docs.rst | 6 ++++++ 2 files changed, 29 insertions(+) create mode 100644 CONTRIBUTORS.rst diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst new file mode 100644 index 0000000..5ef5fa0 --- /dev/null +++ b/CONTRIBUTORS.rst @@ -0,0 +1,23 @@ +Thanks goes to these wonderful people (`emoji key `_): + +.. raw:: html + + + + + + + + + +

Vaibhav Patel
Håkon Wiik Ånes
📖 🔧 🚇 🚧
+ + + + + + +This project follows the `all-contributors `_ specification. +Contributions of any kind are welcome! + +This list is maintained manually until such time that the all-contributors bot supports rst. A possibly fix may be coming in `PR 301 there `_. \ No newline at end of file diff --git a/README_for_docs.rst b/README_for_docs.rst index 15ee52d..25752b1 100644 --- a/README_for_docs.rst +++ b/README_for_docs.rst @@ -125,3 +125,9 @@ With the shapes lying in a high-dimensional linear space after preprocessing, they can now be submitted to various commonly used statistical procedures like Principal Components Analysis and various kinds of regression for further analysis. + +Contributors ✨ +=============== + +.. include:: CONTRIBUTORS.rst + From 3eba5d99e7097f138ce120d9b228a9639f47d299 Mon Sep 17 00:00:00 2001 From: Vaibhav Patel Date: Tue, 12 Oct 2021 03:20:23 -0400 Subject: [PATCH 2/3] Update changelog --- CHANGELOG.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c8ed983..a11ab2c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -14,6 +14,13 @@ entries are sorted in descending chronological order. Unreleased ========== +Added +----- +- all-contributors section to README. Added manually due to `lack of rst support in the cli, bot `_, but see `PR 301 there `_. + +[0.1.13] - 2021-10-10 +===================== + Added ----- - This project now keeps a changelog. \ No newline at end of file From 349eb9fa7a8bab29b0a0810341a4b2d681a0b029 Mon Sep 17 00:00:00 2001 From: Vaibhav Patel Date: Tue, 12 Oct 2021 03:31:05 -0400 Subject: [PATCH 3/3] Regen README.rst. Add newline before autogen note using line block. --- README.rst | 9 ++++++++- docs/Makefile | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e55e905..f11fb78 100644 --- a/README.rst +++ b/README.rst @@ -118,4 +118,11 @@ they can now be submitted to various commonly used statistical procedures like Principal Components Analysis and various kinds of regression for further analysis. -**(This file was autogenerated from README_for_docs.rst by running `make README_for_gh` in the docs directory)** +Contributors ✨ +=============== + +.. include:: CONTRIBUTORS.rst + + +| +| **(This file was autogenerated from README_for_docs.rst by running `make README_for_gh` in the docs directory)** diff --git a/docs/Makefile b/docs/Makefile index 5c465ea..141ed30 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -17,7 +17,7 @@ help: README_for_gh: @echo "Building docs for GitHub" @cp ../README_for_docs.rst ../$(README_FOR_GH) - echo "\n**(This file was autogenerated from README_for_docs.rst by running \`make README_for_gh\` in the docs directory)**" >> ../$(README_FOR_GH) + echo "\n|\n| **(This file was autogenerated from README_for_docs.rst by running \`make README_for_gh\` in the docs directory)**" >> ../$(README_FOR_GH) sed -i '' -e '/^ :meth:/ d' ../$(README_FOR_GH) # Catch-all target: route all unknown targets to Sphinx using the new