Skip to content

Fix: update project name and make year automated #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions _static/pyos.css
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@
/* anything related to the dark theme */
html[data-theme="dark"] {
--pst-color-info-bg: #400f59!important;
--pst-color-tbl-row: #2E2E2E!important;
}

/* anything related to the light theme */
html[data-theme="light"] {
--pst-color-tbl-row: #f5f1ff!important;
}
}


Expand Down Expand Up @@ -331,3 +338,46 @@ aside.footnote {
background-color: var(--pst-color-target);
}
}


.fa-circle-check {
color: #7BCDBA;
}

/* pyOpenSci table styles */

.pyos-table {
& th.head, .pyos-table th.head.stub {
background-color: #33205C!important;

& p {
color: #fff
}
}
& th.stub {
background-color: var(--pst-color-tbl-row);
font-weight: 500;
}
& td {
vertical-align: middle;
text-align: center;
}
}


/* Make the first column in a table a "header" like thing */


/* Dark mode fix for tables */
@media (prefers-color-scheme: dark) {
td:not(.row-header):nth-child(1) {
background-color: var(--pst-color-tbl-row); /* Adjust the dark mode color */
color: #ffffff; /* Adjust the text color for better contrast */
font-weight: 500;
}
}

td, th {
border: 1px solid #ccc; /* Light gray border */
padding: 8px; /* Add some padding for better readability */
}
21 changes: 17 additions & 4 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------------------------------

Expand Down
10 changes: 9 additions & 1 deletion tutorials/1-installable-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,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.

Expand Down Expand Up @@ -292,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
Expand Down