Skip to content

Commit 0949409

Browse files
committed
deploy: 8a91b4c
1 parent 3978f67 commit 0949409

File tree

11 files changed

+15
-17
lines changed

11 files changed

+15
-17
lines changed

.doctrees/environment.pickle

-322 Bytes
Binary file not shown.
Binary file not shown.
-134 Bytes
Binary file not shown.
-90 Bytes
Binary file not shown.

_sources/package-structure-code/publish-python-package-pypi-conda.md.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ Click here for a tutorial on publishing your package to PyPI.
4848
:::
4949

5050

51-
```{tip}
51+
:::{tip}
5252
On the package build page, we discussed the [two package distribution
5353
types that you will create when making a Python package](python-package-distribution-files-sdist-wheel): SDist (packaged as a .tar.gz or .zip) and
5454
Wheel (.whl) which is really a zip file. Both of those file "bundles" will
5555
be published on PyPI when you use [a standard build tool](python-package-build-tools) to build
5656
your package.
57-
```
57+
:::
5858

5959
(about-conda)=
6060
## What is Anaconda Cloud and conda?
@@ -154,11 +154,11 @@ to use conda to manage their local environments (which many do), you should
154154
consider publishing to both PyPI and the conda-forge channel (_more
155155
on that below_).
156156

157-
```{admonition} Additional resources
158-
* [learn more about why conda-forge was created, here](https://conda-forge.org/docs/user/introduction.html#why-conda-forge)
157+
:::{admonition} Additional resources
158+
* [learn more about why conda-forge was created, here](https://conda-forge.org/docs/user/introduction.html)
159159

160160
* [To learn more about conda terminology, check out their glossary.](https://docs.conda.io/projects/conda/en/latest/glossary.html )
161-
```
161+
:::
162162

163163
<!-- One of our packages on conda-forge https://anaconda.org/conda-forge/pandera -->
164164

@@ -169,7 +169,7 @@ we encourage you to consider doing so!
169169

170170
Once your package is on PyPI, the process to add your package to conda-forge
171171
is straight forward to do. [You can follow the detailed steps provided
172-
by the conda-forge maintainer team.](https://conda-forge.org/docs/maintainer/adding_pkgs.html#generating-the-recipe).
172+
by the conda-forge maintainer team.](https://conda-forge.org/docs/maintainer/adding_pkgs.html).
173173

174174

175175
:::{button-link} ../tutorials/publish-conda-forge.html
@@ -184,9 +184,9 @@ If you want a step by step tutorial, click here.
184184

185185
Once your package is added, you will have a feedstock repository on GitHub with your packages name
186186

187-
```{tip}
187+
:::{tip}
188188
[Here is an example conda-forge feedstock for the pyOpenSci approved package - movingpandas](https://github.com/conda-forge/movingpandas-feedstock)
189-
```
189+
:::
190190

191191
### Maintaining your conda-forge package repository
192192

_sources/tutorials/add-readme.md.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,6 @@ Short description here using non-technical language that describes what your pac
187187

188188
## How to install pyosPackage
189189

190-
<todo - when i add more to the pyos package this can use that readme>
191190
To install this package run:
192191

193192
`pip install pyosPackage`
@@ -223,7 +222,7 @@ above is a set of recommendations as you are just getting started. You may find
223222
the need for other elements to be added to this file as you further develop your
224223
package and as a community begins to use your package.
225224

226-
In the [next lesson](add-license-coc), you will add a LICENSE file to
225+
In the [next lesson](add-license-coc.md), you will add a LICENSE file to
227226
your Python package. A license file is critical as it tells users
228227
how they legally can (and can't) use your package. It also:
229228

_sources/tutorials/publish-conda-forge.md.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ build:
403403
number: 0
404404
```
405405

406-
> - [x] A tarball (`url`) rather than a repo (e.g. `git_url`) is used in your recipe (see [here](https://conda-forge.org/docs/maintainer/adding_pkgs.html#build-from-tarballs-not-repos) for more details).
406+
> - [x] A tarball (`url`) rather than a repo (e.g. `git_url`) is used in your recipe (see [here](https://conda-forge.org/docs/maintainer/adding_pkgs.html) for more details).
407407

408408
**Translation:** Here conda wants you to provide a link to the source distribution on PyPI rather than a link to your GitHub repository distribution. Notice above in the Source section of your recipe there is a `url:` section that provides a PyPI url that ends in tar.gz. That is a link to your source distribution that conda-forge will use.
409409

package-structure-code/publish-python-package-pypi-conda.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,7 @@ <h3>Take-aways: If you can, publish on both PyPI and conda-forge to accommodate
652652
<div class="admonition-additional-resources admonition">
653653
<p class="admonition-title">Additional resources</p>
654654
<ul class="simple">
655-
<li><p><a class="reference external" href="https://conda-forge.org/docs/user/introduction.html#why-conda-forge">learn more about why conda-forge was created, here</a></p></li>
655+
<li><p><a class="reference external" href="https://conda-forge.org/docs/user/introduction.html">learn more about why conda-forge was created, here</a></p></li>
656656
<li><p><a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/glossary.html">To learn more about conda terminology, check out their glossary.</a></p></li>
657657
</ul>
658658
</div>
@@ -664,7 +664,7 @@ <h2>How to submit to conda-forge<a class="headerlink" href="#how-to-submit-to-co
664664
<p>While pyOpenSci doesn’t require you to add your package to conda-forge,
665665
we encourage you to consider doing so!</p>
666666
<p>Once your package is on PyPI, the process to add your package to conda-forge
667-
is straight forward to do. <a class="reference external" href="https://conda-forge.org/docs/maintainer/adding_pkgs.html#generating-the-recipe">You can follow the detailed steps provided
667+
is straight forward to do. <a class="reference external" href="https://conda-forge.org/docs/maintainer/adding_pkgs.html">You can follow the detailed steps provided
668668
by the conda-forge maintainer team.</a>.</p>
669669
<p><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-rounded-pill float-left reference external" href="../tutorials/publish-conda-forge.html"><span>Click here for a tutorial on adding your package to conda-forge.</span></a></p>
670670
<p>If you want a step by step tutorial, click here.</p>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tutorials/add-readme.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -685,7 +685,6 @@ <h2>The finished README file<a class="headerlink" href="#the-finished-readme-fil
685685

686686
<span class="gu">## How to install pyosPackage</span>
687687

688-
&lt;todo - when i add more to the pyos package this can use that readme&gt;
689688
To install this package run:
690689

691690
<span class="sb">`pip install pyosPackage`</span>
@@ -721,7 +720,7 @@ <h2>The finished README file<a class="headerlink" href="#the-finished-readme-fil
721720
the need for other elements to be added to this file as you further develop your
722721
package and as a community begins to use your package.
723722

724-
In the [<span class="nt">next lesson</span>](<span class="na">add-license-coc</span>), you will add a LICENSE file to
723+
In the [<span class="nt">next lesson</span>](<span class="na">add-license-coc.md</span>), you will add a LICENSE file to
725724
your Python package. A license file is critical as it tells users
726725
how they legally can (and can&#39;t) use your package. It also:
727726

tutorials/publish-conda-forge.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -887,7 +887,7 @@ <h3 class="rubric" id="conda-forge-staged-recipes-pull-request-checklist">Conda-
887887
</div>
888888
<blockquote>
889889
<div><ul class="simple">
890-
<li><p class="sd-card-text">[x] A tarball (<code class="docutils literal notranslate"><span class="pre">url</span></code>) rather than a repo (e.g. <code class="docutils literal notranslate"><span class="pre">git_url</span></code>) is used in your recipe (see <a class="reference external" href="https://conda-forge.org/docs/maintainer/adding_pkgs.html#build-from-tarballs-not-repos">here</a> for more details).</p></li>
890+
<li><p class="sd-card-text">[x] A tarball (<code class="docutils literal notranslate"><span class="pre">url</span></code>) rather than a repo (e.g. <code class="docutils literal notranslate"><span class="pre">git_url</span></code>) is used in your recipe (see <a class="reference external" href="https://conda-forge.org/docs/maintainer/adding_pkgs.html">here</a> for more details).</p></li>
891891
</ul>
892892
</div></blockquote>
893893
<p class="sd-card-text"><strong>Translation:</strong> Here conda wants you to provide a link to the source distribution on PyPI rather than a link to your GitHub repository distribution. Notice above in the Source section of your recipe there is a <code class="docutils literal notranslate"><span class="pre">url:</span></code> section that provides a PyPI url that ends in tar.gz. That is a link to your source distribution that conda-forge will use.</p>

0 commit comments

Comments
 (0)