Skip to content

Commit c0da378

Browse files
fix errors
1 parent aa2dba2 commit c0da378

File tree

5 files changed

+8
-7
lines changed

5 files changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
orphan: true
3+
---
14
# Contributing Guide for the Python open source software packaging book
25

36
This is a community resource. We welcome contributions in the form of issues and/or pull requests to this guide.

conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
"attrs_block",
6262
]
6363
myst_heading_anchors = 3
64+
myst_footnote_transition = False
6465

6566
# Sphinx_favicon is used now in favor of built in support
6667
# https://pypi.org/project/sphinx-favicon/

tutorials/add-license-coc.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,13 +170,12 @@ The `CODE_OF_CONDUCT.md` should be placed at the root of your project directory,
170170
That's it - you've now added a code of conduct to your package directory.
171171

172172
:::{admonition} Additional Code of Conduct resources
173-
:class: note
174173

175174
- [<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)
176175
- [pyOpenSci package guide `CODE_OF_CONDUCT.md` overview](https://www.pyopensci.org/python-package-guide/documentation/repository-files/code-of-conduct-file.html)
177-
178176
:::
179177

178+
180179
## <i class="fa-solid fa-hands-bubbles"></i> Wrap up
181180

182181
In this lesson and the [last lesson](add-readme), you have added a:

tutorials/installable-code.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -587,9 +587,7 @@ Type "help", "copyright", "credits" or "license" for more information.
587587
3
588588
```
589589
590-
591590
:::{admonition} Installing packages from GitHub
592-
593591
If you wish to share your code without publishing to PyPI you can
594592
always install packages directly from GitHub using the syntax:
595593

tutorials/publish-conda-forge.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Anyone can submit a package to these channels however they must pass a technical
4444

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

47-
:::{figure-md} pypi-conda-channels
47+
:::{figure-md} pypi-conda-channels-2
4848

4949
<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">
5050

@@ -228,7 +228,7 @@ where it saved the recipe file.
228228

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

231-
```yaml
231+
```yaml+jinja
232232
{% set name = "pyospackage" %}
233233
{% set version = "0.1.8" %}
234234
@@ -421,7 +421,7 @@ This is also why we don't suggest you publish to conda-forge as a practice run.
421421

422422
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.
423423

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

426426
<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">
427427

0 commit comments

Comments
 (0)