Merge branch 'main' into pkg-deps

Author: lwasser

.all-contributorsrc

@@ -314,6 +314,36 @@
         "code",
         "review"
       ]
+    },
+    {
+      "login": "Zeitsperre",
+      "name": "Trevor James Smith",
+      "avatar_url": "https://avatars.githubusercontent.com/u/10819524?v=4",
+      "profile": "https://github.com/Zeitsperre",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "merwok",
+      "name": "Éric",
+      "avatar_url": "https://avatars.githubusercontent.com/u/635179?v=4",
+      "profile": "https://github.com/merwok",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "kcranston",
+      "name": "Karen Cranston",
+      "avatar_url": "https://avatars.githubusercontent.com/u/312034?v=4",
+      "profile": "https://karencranston.ca/",
+      "contributions": [
+        "code",
+        "review"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/build-book.yml

@@ -1,7 +1,7 @@
 name: build-test-deploy-book
 
 # Only build PRs, the main branch, and releases. Pushes to branches will only
-# be built when a PR is opened. This avoids duplicated buids in PRs coming
+# be built when a PR is opened. This avoids duplicated builds in PRs coming
 # from branches in the origin repository (1 for PR and 1 for push).
 # This came from Leo's work with fatiando
 on:

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
 
   # Misc commit checks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     # ref: https://github.com/pre-commit/pre-commit-hooks#hooks-available
     hooks:
       # Autoformat: Makes sure files end in a newline and only a newline.
@@ -26,7 +26,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.5
+    rev: v2.2.6
     hooks:
     - id: codespell
       additional_dependencies:

README.md

@@ -1,6 +1,6 @@
-# <img src="images/logo/logo.png" width=40 /> pyOpenSci Scientific Python Open Source Packaging Guide
+# <img src="images/logo/logo.png" width=40 /> pyOpenSci scientific Python Packaging Guide
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-30-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-33-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/python-package-guide?color=purple&display_name=tag&style=plastic)
@@ -115,6 +115,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/isabelizimm"><img src="https://avatars.githubusercontent.com/u/54685329?v=4?s=100" width="100px;" alt="Isabel Zimmerman"/><br /><sub><b>Isabel Zimmerman</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=isabelizimm" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Aisabelizimm" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://orcid.org/0000-0001-6628-8033"><img src="https://avatars.githubusercontent.com/u/8931994?v=4?s=100" width="100px;" alt="Nick Murphy"/><br /><sub><b>Nick Murphy</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=namurphy" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Anamurphy" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Zeitsperre"><img src="https://avatars.githubusercontent.com/u/10819524?v=4?s=100" width="100px;" alt="Trevor James Smith"/><br /><sub><b>Trevor James Smith</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Zeitsperre" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3AZeitsperre" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/merwok"><img src="https://avatars.githubusercontent.com/u/635179?v=4?s=100" width="100px;" alt="Éric"/><br /><sub><b>Éric</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=merwok" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Amerwok" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://karencranston.ca/"><img src="https://avatars.githubusercontent.com/u/312034?v=4?s=100" width="100px;" alt="Karen Cranston"/><br /><sub><b>Karen Cranston</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=kcranston" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Akcranston" title="Reviewed Pull Requests">👀</a></td>
     </tr>
   </tbody>
 </table>

_static/pyos.css

@@ -1,28 +1,51 @@
+html, body {
+    font-size: 1.0rem;
+}
+
+/* Allow the center content to expand to wide on wide screens */
+@media (min-width: 960px){
+.bd-page-width {
+    max-width: min(100%, 1600px)!important;
+    }
+}
+
+/* Make sure the header nav is centered  - not sure why it's not overriding*/
+.navbar-header-items .me-auto, .me-auto .navbar-header-items__center {
+    margin-left: auto!important;
+    margin-right: auto!important;
+}
+
+/* custom fonts */
+
 html, body {
     font-size: 1.02rem;
+    font-family: 'Poppins', sans-serif!important;
 }
 
 body p {
 }
 
 .admonition {
-    margin-top: 40px;
-    margin-bottom: 40px;
+    margin-top: 60px!important;
+    margin-bottom: 70px!important;
 }
 
-h1, h2, h3, h4 {
+h2, h3, h4 {
+    font-family: 'Poppins', sans-serif!important;
 }
 
 h1 {
-    margin-top: 50px;
+    margin-top: 10px;
     margin-bottom: 40px;
+    font-family: 'Itim'!important;
+    color: #542568;
 }
 h2 {
-    margin-top: 60px;
+    margin-top: 80px;
 }
 
 h3 {
-    margin-top: 40px}
+    margin-top: 60px}
 
 figcaption .caption-text {
     text-align: left!important;
@@ -40,5 +63,107 @@ figcaption {
 
 
 .admonition p {
-    font-size: 1em;
+    font-size: .9em;
+}
+
+
+/* Tutorial block page */
+.left-div {
+    background-color: #3498db;
+    color: #fff;
+    text-align: center;
+    padding: 20px;
+    width: 35%;
+    border-radius: 10px;
+}
+
+.right-div {
+    margin-top: 10px;
+}
+
+.lesson-div {
+    cursor: pointer;
+    transition: background-color 0.3s;
+    margin-bottom: 10px;
+    padding: 10px;
+    border-radius: 5px;
+    text-align: center;
+    color: #333;
+}
+
+.lesson-div a {
+    color: inherit;
+    text-decoration: none;
+    display: block;
+    height: 100%;
+    width: 100%;
+}
+
+.lesson-div:hover {
+    background-color: #ccc;
+}
+
+/* Different colors and their shades */
+.lesson-div:nth-child(1) {
+    background-color: #216A6B;
+    color: #fff;
+}
+
+.lesson-div:nth-child(2) {
+    background-color: #6D597A;
+    color: #fff;
+}
+
+.lesson-div:nth-child(3) {
+    background-color: #B56576;
+    color: #fff;
+}
+
+.lesson-div:nth-child(4) {
+    background-color: #3A8C8E; /* Shade of #216A6B */
+}
+
+.lesson-div:nth-child(5) {
+    background-color: #8F7B8D; /* Shade of #6D597A */
+}
+
+.lesson-div:nth-child(6) {
+    background-color: #D78287; /* Shade of #B56576 */
+}
+
+.lesson-div:nth-child(7) {
+    background-color: #185355; /* Darker shade of #216A6B */
+    color: #fff;
+}
+
+
+
+html[data-theme=light] {
+    --pst-color-primary: #703c87;
+    --pst-color-primary-text: #fff;
+    --pst-color-primary-highlight: #053f49;
+    --sd-color-primary: var(--pst-color-primary);
+    --sd-color-primary-text: var(--pst-color-primary-text);
+    --sd-color-primary-highlight: var(--pst-color-primary-highlight);
+    --sd-color-primary-bg: #d0ecf1;
+    --sd-color-primary-bg-text: #14181e;
+    --pst-color-secondary: #8045e5;
+    --pst-color-secondary-text: #fff;
+    --pst-color-secondary-highlight: #591bc2;
+    --sd-color-secondary: var(--pst-color-secondary);
+    --sd-color-secondary-text: var(--pst-color-secondary-text);
+    --sd-color-secondary-highlight: var(--pst-color-secondary-highlight);
+    --sd-color-secondary-bg: #e0c7ff;
+    --sd-color-secondary-bg-text: #14181e;
+    --pst-color-success: #00843f;
+    --pst-color-success-text: #fff;
+    --pst-color-success-highlight: #00381a;
+    --sd-color-success: var(--pst-color-success);
+    --sd-color-success-text: var(--pst-color-success-text);
+    --sd-color-success-highlight: var(--pst-color-success-highlight);
+    --sd-color-success-bg: #d6ece1;
+    --sd-color-success-bg-text: #14181e;
+    --pst-color-info: #A66C98; /* general admonition */
+    --pst-color-info-bg: #eac8e2;
+    --pst-heading-color: #542568;
 }

_templates/header.html

@@ -1,6 +1,6 @@
 <!-- custom head content-->
-
-<!-- <link rel="preconnect" href="https://fonts.googleapis.com">
+<link rel="preconnect" href="https://fonts.googleapis.com">
 <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600&family=Raleway:wght@200;300;400;600&display=swap" rel="stylesheet">  -->
+<link href="https://fonts.googleapis.com/css2?family=Itim&family=Poppins:wght@300;400;600&display=swap" rel="stylesheet">
+
 <!-- END custom head content -->

conf.py

@@ -51,7 +51,15 @@
 
 # Link to our repo for easy PR/ editing
 html_theme_options = {
+       "favicons": [
+      {
+         "rel": "icon",
+         "sizes": "16x16",
+         "href": "https://www.pyopensci.org/images/favicon.ico",
+      },
+    ],
     "announcement": "<p><a href='https://www.pyopensci.org/software-peer-review/about/intro.html'>Submit Your Python Package for Peer Review - Learn More!</a></p>🚧 This guide is currently being developed! 🚧 ",
+    #"navbar_center": ["nav"], this can be a way to override the default navigation structure
     "external_links": [
         {
             "url": "https://www.pyopensci.org",
@@ -74,17 +82,19 @@
         },
     ],
     "logo": {
-        "text": "Python Package Guide",
+        "text": "Python Packaging",
         "image_dark": "logo-dark-mode.png",
         "image_light": "logo-light-mode.png",
         "alt_text": "pyOpenSci Python Package Guide. The pyOpenSci logo is a purple flower with pyOpenSci under it. The o in open sci is the center of the flower",
     },
-    "header_links_before_dropdown": 3,
+    "header_links_before_dropdown": 4,
     "use_edit_page_button": True,
+    "show_nav_level": 2,
+    "navigation_depth": 3,
     "show_toc_level": 1,
     # "navbar_align": "left",  # [left, content, right] For testing that the navbar items align properly
     "github_url": "https://github.com/pyopensci/python-package-guide",
-    "twitter_url": "https://twitter.com/pyopensci",
+
     "footer_items": ["copyright"],
 }
 

documentation/repository-files/code-of-conduct-file.md

@@ -1,13 +1,13 @@
-# The CODE_OF_CONDUCT.md file In Your Python Open Source Package
+# The CODE_OF_CONDUCT file - Python Packaging
 
-```{admonition} Example Code of Conduct files
+```{admonition} Example CODE_OF_CONDUCT files
 :class: tip
 
 * [SciPy Code of Conduct file - notice they included theirs in their documentation](https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html)
-* [fatiando code of conduct file](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)
+* [fatiando CODE_OF_CONDUCT.md file](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)
 ```
 
-Your package should have a **CODE_OF_CONDUCT.md** file located
+Your package should have a `CODE_OF_CONDUCT.md` file located
 the root of the repository. Once you have people using your
 package, you can consider the package itself as having a community
 around it. Some of this community uses your tool. These users
@@ -17,20 +17,20 @@ Others in the community might want to contribute to your tool.
 They might fix bugs, update documentation and engage with the
 maintainer team.
 
-## Why you need a code of conduct
+## Why you need a CODE_OF_CONDUCT
 
 In order to keep this community healthy and to protect yourself,
-your mainatianer team and your users from unhealthy behavior,
-it is important to have a [code of conduct](https://opensource.guide/code-of-conduct/).
+your maintainer team and your users from unhealthy behavior,
+it is important to have a [`CODE_OF_CONDUCT`](https://opensource.guide/code-of-conduct/).
 
-The code of conduct is important
+The `CODE_OF_CONDUCT` is important
 as it establishes what you expect in terms of how users and
 contributors interact with maintainers and each other. It also
 establishes rules and expectations which can then be enforced
-if need be to protect others from harmful and/or negative  behaviors.
+if need be to protect others from harmful and/or negative behaviors.
 
 If you are not comfortable
-with creating your own code of conduct text, we encourage you to adopt the
-code of conduct language used in the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
-[Many other communities](https://www.contributor-covenant.org/adopters/) have adopted this code of conduct as
+with creating your own `CODE_OF_CONDUCT` text, we encourage you to adopt the
+`CODE_OF_CONDUCT` language used in the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+[Many other communities](https://www.contributor-covenant.org/adopters/) have adopted this `CODE_OF_CONDUCT` as
 their own. See the [Fatiando a Terra Geoscience Python community's example here.](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)