Skip to content

Fix broken stuff 2 (and keep stuff unbroken) #205

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
Mar 20, 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
2 changes: 1 addition & 1 deletion .github/workflows/build-book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
run: python3 -m pip install nox

- name: Build book
run: nox -s docs
run: nox -s docs-test

# Save html as artifact
- name: Save book html as artifact for viewing
Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
orphan: true
---
# Contributing Guide for the Python open source software packaging book

This is a community resource. We welcome contributions in the form of issues and/or pull requests to this guide.
Expand Down
1 change: 1 addition & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
"attrs_block",
]
myst_heading_anchors = 3
myst_footnote_transition = False

# Sphinx_favicon is used now in favor of built in support
# https://pypi.org/project/sphinx-favicon/
Expand Down
11 changes: 11 additions & 0 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,17 @@ def docs(session):
cmd.extend(build_command + session.posargs)
session.run(*cmd)

@nox.session(name="docs-test")
def docs_test(session):
"""
Same as `docs`, but rebuild everything and fail on warnings for testing
"""
session.install("-r", "requirements.txt")
cmd = ["sphinx-build"]
cmd.extend(['-W', '--keep-going', '-E', '-a'])
cmd.extend(build_command + session.posargs)
session.run(*cmd)


@nox.session(name="docs-live")
def docs_live(session):
Expand Down
1 change: 0 additions & 1 deletion tutorials/add-license-coc.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,6 @@ That's it - you've now added a code of conduct to your package directory.

- [<i class="fa-brands fa-github"></i> Guide: `CODE_OF_CONDUCT.md` files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
- [pyOpenSci package guide `CODE_OF_CONDUCT.md` overview](https://www.pyopensci.org/python-package-guide/documentation/repository-files/code-of-conduct-file.html)

:::

## <i class="fa-solid fa-hands-bubbles"></i> Wrap up
Expand Down
6 changes: 3 additions & 3 deletions tutorials/publish-conda-forge.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Anyone can submit a package to these channels however they must pass a technical

[Learn more about conda channels here.](#about-conda)

:::{figure-md} pypi-conda-channels
:::{figure-md} pypi-conda-channels-2

<img src="../images/python-pypi-conda-channels.png" alt="Graphic with the title Python package repositories. Below it says anything hosted on PyPI can be installed using pip install. Packaging hosted on a conda channel can be installed using conda install. Below that there are two rows. The top row says conda channels. Next to it are three boxes one with conda-forge, community maintained; bioconda and then default - managed by the Anaconda team. Below that there is a row that says PyPI servers. PyPI - anyone can publish to PyPI and test PyPI (a testbed server for you to practice)." width="700px">

Expand Down Expand Up @@ -228,7 +228,7 @@ where it saved the recipe file.

Open the meta.yaml file. The finished `meta.yaml` file that grayskull creates should look like the example below:

```yaml
```yaml+jinja
{% set name = "pyospackage" %}
{% set version = "0.1.8" %}

Expand Down Expand Up @@ -421,7 +421,7 @@ This is also why we don't suggest you publish to conda-forge as a practice run.

Once you create your pull request, a suite of CI actions will run that build and test the build of your package. A conda-forge maintainer will work with you to get your recipe in good shape and merged.

:::{figure-md} pypi-conda-channels
:::{figure-md} conda-forge-pr-build

<img src="../images/conda-forge-staged-recipes-ci.png" alt="Image showing the 5 CI tasks that will run against your package in the GitHub interface after you'ce created a pull request. " width="700px">

Expand Down