Merge branch 'main' into run-tests

Author: lwasser

CONTRIBUTING.md

@@ -33,13 +33,13 @@ To do so, follow these steps:
 2. Build the documentation:
 
    ```
-   nox -s docs_build
+   nox -s docs
    ```
 
 This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`.
 
 To build live documentation that updates when you update local files, run the following command:
 
 ```
-nox -s docs_live
+nox -s docs-live
 ```

_static/pyopensci-python-package-guide.png

@@ -26,7 +26,7 @@ html[data-theme="dark"] {
 
 /* anything related to the light theme */
 html[data-theme="light"] {
-    --pst-color-tbl-row: #E1DEE9!important;
+    --pst-color-tbl-row: #f5f1ff!important;
 }
 }
 
@@ -341,7 +341,7 @@ aside.footnote {
 
 
 .fa-circle-check {
-    color: #49b7b9;
+    color: #7BCDBA;
 }
 
 /* pyOpenSci table styles */
@@ -381,4 +381,3 @@ td, th {
     border: 1px solid #ccc; /* Light gray border */
     padding: 8px; /* Add some padding for better readability */
   }
-

_static/pyos.css

@@ -13,16 +13,29 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+from datetime import datetime
+import subprocess
+
+current_year = datetime.now().year
+organization_name = "pyOpenSci"
+
 
 
 # -- Project information -----------------------------------------------------
 
-project = "python-package-guide"
-copyright = "2024, pyOpenSci"
+project = "pyOpenSci Python Package Guide"
+copyright = f"{current_year}, {organization_name}"
 author = "pyOpenSci Community"
 
-# The full version, including alpha/beta/rc tags
-release = "0.1"
+# Get the latest Git tag - there might be a prettier way to do this but...
+try:
+    release_value = subprocess.check_output(["git", "describe", "--tags"]).decode("utf-8").strip()
+    release_value = release_value[:4]
+except subprocess.CalledProcessError:
+    release_value = "0.1"  # Default value in case there's no tag
+
+# Update the release value
+release = release_value
 
 # -- General configuration ---------------------------------------------------
 

conf.py

@@ -1,3 +1,8 @@
+---
+:og:description: Learn how to make your Python code installable so you can use it across projects.
+:og:title: Make your Python code installable so it can be used across projects
+---
+
 # Make your Python code installable
 
 :::{admonition} What we previously covered
@@ -47,7 +52,11 @@ environment and shell on your computer.
 You are welcome to use any Python environment manager that you choose.
 If you are using Windows or are not familiar with Shell, you may want to check out the Carpentries shell lesson[^shell-lesson]. Windows users will likely need to configure a tool for any Shell and git related steps.
 
+:::{todo}
+When this lesson is published, unlink
 * [If you need guidance creating a Python environment, review this lesson](extras/1-create-environment.md) which walks you through creating an environment using both `venv` and `conda`.
+:::
+
 * If you aren't sure which environment manager to use and
 you are a scientist, we suggest that you use `conda`, particularly if you are working with spatial data.
 
@@ -287,8 +296,12 @@ For instance, a `build-system` table most often holds two (2) variables:
 2. `build-backend = `, which is used to define the specific build-backend name, (in this example we are using `hatchling.build`).
 
 TOML organizes data structures, defining relationships within a configuration
-file. You will learn more about the `pyproject.toml` format in the
+file.
+
+:::{todo}
+You will learn more about the `pyproject.toml` format in the
 [next lesson when you add additional metadata / information to this file.](5-pyproject-toml.md)
+:::
 
 ```toml
 # An example of the build-system table which contains two variables - requires and build-backend