rebase 2

lwasser · lwasser · commit 39b992e1848f · 2022-12-21T12:40:01.000-07:00
diff --git a/_static/pyos.css b/_static/pyos.css
@@ -1,14 +1,18 @@
---font-stack: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial,
-    sans-serif, Apple Color Emoji, Segoe UI Emoji;
 
 body, p {
-  font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
+  font-size: 1.04em;
 }
 
 h1, h2, h3 {
-  font-family:'Franklin Gothic Medium', 'Arial Narrow', Arial, sans-serif;
+  font-family:'Franklin Gothic Medium', Arial, sans-serif;
   font-weight: bold;
 }
+
+h1 {
+  margin-bottom: 1em;
+  font-size: 2.5rem;
+}
+
 h2 {
   margin-top: 1.7em;
 }
@@ -17,7 +21,18 @@ h3, .content-container h3 {
   margin-top: 1.6em!important;
 }
 
-/* HEADER BLOCK */ 
+ul li p {
+  padding-bottom: .8em;
+  line-height: 1.5em;
+}
+
+.epigraph {
+  font-style: italic;
+  border-left: 4px solid #ccc!important;
+  margin-left: 0!important;
+  font-size: 1.2em!important;
+}
+
 div.header__block { 
   color: #222;
 }
@@ -37,37 +52,9 @@ div.header__block {
   background-color:#ccc;
 }
 
-div .announcement .header-item .noprint, header-item.announcement {
-  background-color: #ccc!important;
-} */
-
-/* notes */
 div.admonition.note {
   margin-top: 4em;
   margin-bottom: 4em;
   background-color: #F8F9FB
 }
 
-div.admonition.note .admonition-title, div.admonition.note .admonition-title::before {
-  
-}
-
-/* div.admonition.note {
-    border-color: #C1CFD4;
-    background-color: #E3F4FA;
-} */
-
-/* div.admonition.important .admonition-title, div.admonition.important .admonition-title::before {
-  background-color: #107762;
-  color: #ffffff!important;
-} */
-
-/* div.admonition.important .admonition-title {
-  background-color: #107762;
-  border-color: #1abc9c;
-} */
-
-/* div.admonition.important {
-    border-color: #0e6654;
-    background-color: #ecfcf9;
-} */
diff --git a/appendices/review-template.md b/appendices/review-template.md
@@ -0,0 +1,81 @@
+## Peer Review Template
+
+```
+## Package Review
+
+*Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide*
+
+- [ ] As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor _before_ starting your review).
+
+#### Documentation
+
+The package includes all the following forms of documentation:
+
+- [ ] **A statement of need** clearly stating problems the software is designed to solve and its target audience in README
+- [ ] **Installation instructions:** for the development version of package and any non-standard dependencies in README
+- [ ] **Vignette(s)** demonstrating major functionality that runs successfully locally
+- [ ] **Function Documentation:** for all user-facing functions
+- [ ] **Examples** for all user-facing functions
+- [ ] **Community guidelines** including contribution guidelines in the README or CONTRIBUTING.
+- [ ] **Metadata** including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a `setup.py` file or elsewhere.
+
+Readme requirements
+The package meets the readme requirements below:
+
+- [ ] Package has a README.md file in the root directory.
+
+The README should include, from top to bottom:
+
+- [ ] The package name
+- [ ] Badges for continuous integration and test coverage, a repostatus.org badge, and any other badges. If the README has many more badges, you might want to consider using a table for badges: [see this example](https://github.com/ropensci/drake). Such a table should be more wide than high. (Note that the badge for pyOpenSci peer-review will be provided upon acceptance.)
+- [ ] Short description of goals of package, with descriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README.
+- [ ] Installation instructions
+- [ ] Any additional setup required (authentication tokens, etc)
+- [ ] Brief demonstration usage
+- [ ] Direction to more detailed documentation (e.g. your documentation files or website).
+- [ ] If applicable, how the package compares to other similar packages and/or how it relates to other packages
+- [ ] Citation information
+
+#### Usability
+Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
+Package structure should follow general community best-practices. In general please consider:
+
+- [ ] The documentation is easy to find and understand
+- [ ] The need for the package is clear
+- [ ] All functions have documentation and associated examples for use
+
+
+#### Functionality
+
+- [ ] **Installation:** Installation succeeds as documented.
+- [ ] **Functionality:** Any functional claims of the software been confirmed.
+- [ ] **Performance:** Any performance claims of the software been confirmed.
+- [ ] **Automated tests:** Tests cover essential functions of the package and a reasonable range of inputs and conditions. All tests pass on the local machine.
+- [ ] **Continuous Integration:** Has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.
+- [ ] **Packaging guidelines**: The package conforms to the pyOpenSci [packaging guidelines](https://www.pyopensci.org/contributing-guide/authoring/index.html#packaging-guide).
+
+#### For packages co-submitting to JOSS
+
+- [ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements](http://joss.theoj.org/about#submission_requirements).
+
+*Note:* Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.
+
+The package contains a `paper.md` matching [JOSS's requirements](http://joss.theoj.org/about#paper_structure) with:
+
+- [ ] **A short summary** describing the high-level functionality of the software
+- [ ] **Authors:** A list of authors with their affiliations
+- [ ] **A statement of need** clearly stating problems the software is designed to solve and its target audience.
+- [ ] **References:** with DOIs for all those that have one (e.g. papers, datasets, software).
+
+#### Final approval (post-review)
+
+- [ ] **The author has responded to my review and made changes to my satisfaction. I recommend approving this package.**
+
+Estimated hours spent reviewing:
+
+---
+
+#### Review Comments
+
+
+```
diff --git a/appendices/templates.md b/appendices/templates.md
@@ -24,86 +24,8 @@ Reviewers:
 Due date:
 ```
 
-## Review Template
-
-```
-## Package Review
-
-*Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide*
-
-- [ ] As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor _before_ starting your review).
-
-#### Documentation
-
-The package includes all the following forms of documentation:
-
-- [ ] **A statement of need** clearly stating problems the software is designed to solve and its target audience in README
-- [ ] **Installation instructions:** for the development version of package and any non-standard dependencies in README
-- [ ] **Vignette(s)** demonstrating major functionality that runs successfully locally
-- [ ] **Function Documentation:** for all user-facing functions
-- [ ] **Examples** for all user-facing functions
-- [ ] **Community guidelines** including contribution guidelines in the README or CONTRIBUTING.
-- [ ] **Metadata** including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a `setup.py` file or elsewhere.
-
-Readme requirements
-The package meets the readme requirements below:
-
-- [ ] Package has a README.md file in the root directory.
-
-The README should include, from top to bottom:
-
-- [ ] The package name
-- [ ] Badges for continuous integration and test coverage, a repostatus.org badge, and any other badges. If the README has many more badges, you might want to consider using a table for badges: [see this example](https://github.com/ropensci/drake). Such a table should be more wide than high. (Note that the badge for pyOpenSci peer-review will be provided upon acceptance.)
-- [ ] Short description of goals of package, with descriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README.
-- [ ] Installation instructions
-- [ ] Any additional setup required (authentication tokens, etc)
-- [ ] Brief demonstration usage
-- [ ] Direction to more detailed documentation (e.g. your documentation files or website).
-- [ ] If applicable, how the package compares to other similar packages and/or how it relates to other packages
-- [ ] Citation information
-
-#### Usability
-Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
-Package structure should follow general community best-practices. In general please consider:
-
-- [ ] The documentation is easy to find and understand
-- [ ] The need for the package is clear
-- [ ] All functions have documentation and associated examples for use
-
-
-#### Functionality
-
-- [ ] **Installation:** Installation succeeds as documented.
-- [ ] **Functionality:** Any functional claims of the software been confirmed.
-- [ ] **Performance:** Any performance claims of the software been confirmed.
-- [ ] **Automated tests:** Tests cover essential functions of the package and a reasonable range of inputs and conditions. All tests pass on the local machine.
-- [ ] **Continuous Integration:** Has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.
-- [ ] **Packaging guidelines**: The package conforms to the pyOpenSci [packaging guidelines](https://www.pyopensci.org/contributing-guide/authoring/index.html#packaging-guide).
-
-#### For packages co-submitting to JOSS
-
-- [ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements](http://joss.theoj.org/about#submission_requirements).
-
-*Note:* Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.
-
-The package contains a `paper.md` matching [JOSS's requirements](http://joss.theoj.org/about#paper_structure) with:
-
-- [ ] **A short summary** describing the high-level functionality of the software
-- [ ] **Authors:** A list of authors with their affiliations
-- [ ] **A statement of need** clearly stating problems the software is designed to solve and its target audience.
-- [ ] **References:** with DOIs for all those that have one (e.g. papers, datasets, software).
-
-#### Final approval (post-review)
-
-- [ ] **The author has responded to my review and made changes to my satisfaction. I recommend approving this package.**
-
-Estimated hours spent reviewing:
-
----
-
-#### Review Comments
-
 
+```{include} review-template.md
 ```
 
 ## Review Request Template
diff --git a/conf.py b/conf.py
@@ -36,6 +36,7 @@
     "sphinx.ext.intersphinx",
     "sphinx_sitemap",
     "sphinxext.opengraph",
+    "sphinx_copybutton",
 ]
 
 # colon fence for card support in md
@@ -56,8 +57,6 @@
   "announcement": "🚧 UNDER CONSTRUCTION: this guide is under heavy construction right now. 🚧"
 }
 
-
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
diff --git a/software-peer-review-guide/author-guide.md b/software-peer-review-guide/author-guide.md
@@ -178,9 +178,9 @@ in advance. We will try to help you either.
 * Find a new maintainer to take over your project (or additional maintainers to support maintenance) or
 * Sunset your package.
 
-If the package is sunsetted we will remove it from our curated list 
+If the package is sunsetted, we will remove it from our curated list 
 of vetted tools. 
 
 ### Communication with pyOpenSci and removing tools from our vetted tool list 
 
-To ensure packages that we support and advocate for are maintained, if your package is accepted and we are not able to get in touch with you through normal communication channels (GitHub, email) after reaching our for atleast 1-2 months, we will remove your package from our list of vetted tools. We will also sunset any blogs written that highlight your tool. 
+To ensure packages that we support and advocate for are maintained, if your package is accepted and we are not able to get in touch with you through normal communication channels (GitHub, email) after reaching our for atleast 1-2 months, we will remove your package from our list of vetted tools. We will also deprecate any blogs written that highlight your tool. 
diff --git a/software-peer-review-guide/reviewer-guide.md b/software-peer-review-guide/reviewer-guide.md

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@`
`36`	`36`	`"sphinx.ext.intersphinx",`
`37`	`37`	`"sphinx_sitemap",`
`38`	`38`	`"sphinxext.opengraph",`
	`39`	`+ "sphinx_copybutton",`
`39`	`40`	`]`
`40`	`41`
`41`	`42`	`# colon fence for card support in md`
`@@ -56,8 +57,6 @@`
`56`	`57`	`"announcement": "🚧 UNDER CONSTRUCTION: this guide is under heavy construction right now. 🚧"`
`57`	`58`	`}`
`58`	`59`
`59`		`-`
`60`		`-`
`61`	`60`	`# Add any paths that contain templates here, relative to this directory.`
`62`	`61`	`templates_path = ['_templates']`
`63`	`62`