Skip to content

Commit f0a49a6

Browse files
lwasserlwasser
authored
Enh: Add infrastructure to support a new packaging page
A new section on our website!! learn is next
2 parents 045757c + bd6d5c7 commit f0a49a6

22 files changed

+355
-8
lines changed

‎.github/workflows/build-site.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ jobs:
3535
arguments: |
3636
--ignore-urls "https://fonts.googleapis.com,https://fonts.gstatic.com,_site/_posts/README/index.html"
3737
--ignore-files "/.+\/_posts\/README.md"
38-
--ignore-status-codes "0,403, 429, 503, 999"
38+
--ignore-status-codes "0, 200, 403, 429, 503, 999"

‎_config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,10 @@ whitelist:
245245
- jekyll-redirect-from
246246

247247
collections:
248+
packaging:
249+
people: true
250+
tutorials:
251+
people: true
248252
packages:
249253
output: true
250254
permalink: /:collection/:path/

‎_data/navigation.yml‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,25 @@ main:
99
- title: "Community partners"
1010
icon:
1111
url: "/partners.html"
12+
- title: "Accepted packages"
13+
icon:
14+
url: "/python-packages/"
1215
- title: "Peer review guide"
1316
url: "https://www.pyopensci.org/software-peer-review/"
1417
icon: "fas fa-external-link-alt"
15-
- title: "Python package guide"
18+
- title: "Python Packaging"
19+
icon: "fas fa-fw fa-envelope-square"
20+
url:
21+
sub-nav:
22+
- title: "Packaging resources"
23+
icon:
24+
url: "python-packaging-science.html"
25+
- title: "Our packages"
26+
icon:
27+
url: "/python-packages/"
28+
- title: "Package Guidebook"
1629
url: "https://www.pyopensci.org/python-package-guide/"
1730
icon: "fas fa-external-link-alt"
18-
- title: "Our packages"
19-
icon: "fas fa-fw fa-envelope-square"
20-
url: "/python-packages/index.html"
2131
- title: "Blog"
2232
url: "/blog/index.html"
2333
- title: "Community"

‎_includes/feature_row‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
{% endif %}
1515
{% if f.image_path %}
1616
<div class="archive__item-teaser">
17-
<img src="{{ f.image_path | relative_url }}"
17+
<img src="{{ f.image_path | relative_url }}" {% if f.image_size %} style="width:{{ f.image_size }};"{% endif %}
1818
alt="{% if f.alt %}{{ f.alt }}{% endif %}">
1919
{% if f.image_caption %}
2020
<span class="archive__item-caption">{{ f.image_caption | markdownify | remove: "<p>" | remove: "</p>" }}</span>

‎_includes/tutorial-grid.html‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
<article class="card" itemscope="" itemtype="https://schema.org/CreativeWork">
3+
<div class="content">
4+
<div class="title-block">
5+
<h4 class="title" itemprop="headline">{{ atutorial.title }}</h4>
6+
</div>
7+
{% if atutorial.excerpt %}
8+
<p class="excerpt">
9+
{{ atutorial.excerpt }}
10+
</p>
11+
{% endif %}
12+
13+
{% if atutorial.subpages %}
14+
<ul>
15+
{% for page in atutorial.subpages %}
16+
<li>
17+
<a href="{{ page.url }}">{{ page.name }}</a>
18+
</li>
19+
{% endfor %}
20+
</ul>
21+
22+
{% endif %}
23+
</div>
24+
{% if atutorial.link %}
25+
<a href="{{ atutorial.link }}" class="btn {{ atutorial.btn_class }}"><i class="fa-solid fa-magnifying-glass"></i> {{ atutorial.btn_label }}</a>
26+
{% endif %}
27+
</article>

‎_packaging/documentation.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Document your Python package"
3+
excerpt: "Learn about best practices for developing documentation for your Python package."
4+
learning_objectives:
5+
subpages:
6+
- name: Documentation Overview
7+
url: https://www.pyopensci.org/python-package-guide/documentation/index.html#
8+
- name: Create your docs
9+
url: https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/get-started.html
10+
- name: Create package tutorials
11+
url: https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/create-package-tutorials.html
12+
- name: Document your code (API docs)
13+
url: https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html
14+
15+
url:
16+
---

‎_packaging/packaging.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Create Python package structure"
3+
excerpt: "Learn about the best way to create your Python package."
4+
subpages:
5+
- name: The structure of a Python package
6+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html
7+
- name: Add metadata - pyproject.toml file
8+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/pyproject-toml-python-package-metadata.html
9+
- name: Declare package dependencies
10+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/declare-dependencies.html
11+
- name: Get to know the ecosystem of Python packaging tools
12+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-build-tools.html
13+
- name: Complete package builds
14+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/complex-python-package-builds.html
15+
---

‎_packaging/publish-python-package.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Publish your Python package"
3+
excerpt: "
4+
Learn more about the publishing options for your Python package including publishing on PyPI and the conda-forge channel of conda."
5+
learning_objectives:
6+
subpages:
7+
- name: Build your package for PyPI publication
8+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-distribution-files-sdist-wheel.html
9+
- name: Publish to PyPI and Conda
10+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/publish-python-package-pypi-conda.html#
11+
- name: Versioning your package
12+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-versions.html
13+
- name: Code style and format
14+
url: https://www.pyopensci.org/python-package-guide/package-structure-code/code-style-linting-format.html
15+
url:
16+
---

‎_packaging/tests.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Python package tests"
3+
excerpt: "
4+
Learn more about the importance of writing tests for your Python package and how you can setup infrastructure to run your tests both locally and on GitHub."
5+
learning_objectives:
6+
subpages:
7+
- name: Introduction to writing tests
8+
url: https://www.pyopensci.org/python-package-guide/tests/index.html
9+
- name: Write tests for your Python package
10+
url: https://www.pyopensci.org/python-package-guide/tests/write-tests.html
11+
- name: Three types of types for your Python package
12+
url: https://www.pyopensci.org/python-package-guide/tests/test-types.html
13+
- name: Run tests locally
14+
url: https://www.pyopensci.org/python-package-guide/tests/run-tests.html
15+
- name: Run tests online using Continuous Integration
16+
url: https://www.pyopensci.org/python-package-guide/tests/tests-ci.html
17+
url:
18+
---

‎_pages/home.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: splash
33
title: "Welcome to pyOpenSci"
4+
excerpt: "We support the scientific Python tools that drive open science through peer review, training and community building."
45
author_profile: false
56
published: true
67
site-map: true

0 commit comments

Comments
 (0)