Skip to content

Commit 79c2929

Browse files
committed
deploy: 8def4c1
1 parent b7249ce commit 79c2929

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed
0 Bytes
Binary file not shown.

.doctrees/environment.pickle

0 Bytes
Binary file not shown.

.doctrees/index.doctree

0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

_sources/documentation/repository-files/intro.md.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ at a minimum have the following files:
66

77
The files mentions above (README, Code of Conduct, license
88
file, etc) are used as a measure of package community health
9-
on many online platforms. Below, you can see an example how Github
9+
on many online platforms. Below, you can see an example how GitHub
1010
evaluates community health. This community health link is available for
1111
all GitHub repositories.
1212

@@ -21,7 +21,7 @@ GitHub community health looks for a readme file among other elements when it eva
2121

2222
[Snyk](https://snyk.io/advisor/python) is another well-known company that
2323
keeps tabs on package health. Below you can see a similar evaluation of files
24-
in the Github repo as a measure of community health.
24+
in the GitHub repo as a measure of community health.
2525

2626
```{figure} /images/moving-pandas-python-package-snyk-health.png
2727
---

_sources/index.md.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Publish your docs
5858
```
5959
## _new_ Tutorial Series: Create a Python Package
6060

61-
The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our [Github repo here](https://github.com/pyOpenSci/python-package-guide).
61+
The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our [GitHub repo here](https://github.com/pyOpenSci/python-package-guide).
6262

6363

6464
:::::{grid} 1 1 2 2
@@ -187,7 +187,7 @@ Learn about best practices for:
187187
* [How to publish your docs](/documentation/hosting-tools/intro)
188188
* [Using Sphinx](/documentation/hosting-tools/intro)
189189
* [Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-rst-doc-syntax)
190-
* [Host your docs on Read The Docs or Github Pages](/documentation/hosting-tools/publish-documentation-online)
190+
* [Host your docs on Read The Docs or GitHub Pages](/documentation/hosting-tools/publish-documentation-online)
191191
:::
192192
::::
193193

_sources/tutorials/publish-pypi.md.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Example: `pyosPackage_yourNameHere`.
218218

219219
#### Recommended
220220

221-
- Update the Github repository name to align with the new package name
221+
- Update the GitHub repository name to align with the new package name
222222
- Update your local project folder to match the new package name (e.g. `pyospackage_yourNameHere/src`)
223223
- Update mentions of your repository name in other files (e.g. `README.md`)
224224
:::

documentation/repository-files/intro.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,7 @@ <h1>Documentation Files That Should be in your Python Package Repository<a class
536536
at a minimum have the following files:</p>
537537
<p>The files mentions above (README, Code of Conduct, license
538538
file, etc) are used as a measure of package community health
539-
on many online platforms. Below, you can see an example how Github
539+
on many online platforms. Below, you can see an example how GitHub
540540
evaluates community health. This community health link is available for
541541
all GitHub repositories.</p>
542542
<figure class="align-default" id="moving-pandas-github-community">
@@ -548,7 +548,7 @@ <h1>Documentation Files That Should be in your Python Package Repository<a class
548548
</figure>
549549
<p><a class="reference external" href="https://snyk.io/advisor/python">Snyk</a> is another well-known company that
550550
keeps tabs on package health. Below you can see a similar evaluation of files
551-
in the Github repo as a measure of community health.</p>
551+
in the GitHub repo as a measure of community health.</p>
552552
<figure class="align-default" id="moving-pandas-snyk">
553553
<a class="reference internal image-reference" href="../../_images/moving-pandas-python-package-snyk-health.png"><img alt="Screenshot of the Snyk page for movingpandas. It shows that the repository has a README file, contributing file, code of conduct. It also shows that it has 30 contributors and no funding. The package health score is 78/100." src="../../_images/moving-pandas-python-package-snyk-health.png" style="width: 80%;" />
554554
</a>

index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ <h1>pyOpenSci Python Package Guide<a class="headerlink" href="#pyopensci-python-
489489
</div>
490490
<section id="new-tutorial-series-create-a-python-package">
491491
<h2><em>new</em> Tutorial Series: Create a Python Package<a class="headerlink" href="#new-tutorial-series-create-a-python-package" title="Link to this heading">#</a></h2>
492-
<p>The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our <a class="reference external" href="https://github.com/pyOpenSci/python-package-guide">Github repo here</a>.</p>
492+
<p>The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our <a class="reference external" href="https://github.com/pyOpenSci/python-package-guide">GitHub repo here</a>.</p>
493493
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 text-center docutils">
494494
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
495495
<div class="sd-col sd-d-flex-column docutils">
@@ -633,7 +633,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
633633
<li><p class="sd-card-text"><a class="reference internal" href="documentation/hosting-tools/intro.html"><span class="doc std std-doc">How to publish your docs</span></a></p></li>
634634
<li><p class="sd-card-text"><a class="reference internal" href="documentation/hosting-tools/intro.html"><span class="doc std std-doc">Using Sphinx</span></a></p></li>
635635
<li><p class="sd-card-text"><a class="reference internal" href="documentation/hosting-tools/myst-markdown-rst-doc-syntax.html"><span class="doc std std-doc">Markdown, MyST, and ReST</span></a></p></li>
636-
<li><p class="sd-card-text"><a class="reference internal" href="documentation/hosting-tools/publish-documentation-online.html"><span class="doc std std-doc">Host your docs on Read The Docs or Github Pages</span></a></p></li>
636+
<li><p class="sd-card-text"><a class="reference internal" href="documentation/hosting-tools/publish-documentation-online.html"><span class="doc std std-doc">Host your docs on Read The Docs or GitHub Pages</span></a></p></li>
637637
</ul>
638638
</div>
639639
</div>

tutorials/publish-pypi.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -708,7 +708,7 @@ <h4 class="rubric" id="required">Required</h4>
708708
</ol>
709709
<h4 class="rubric" id="recommended">Recommended</h4>
710710
<ul class="simple">
711-
<li><p class="sd-card-text">Update the Github repository name to align with the new package name</p></li>
711+
<li><p class="sd-card-text">Update the GitHub repository name to align with the new package name</p></li>
712712
<li><p class="sd-card-text">Update your local project folder to match the new package name (e.g. <code class="docutils literal notranslate"><span class="pre">pyospackage_yourNameHere/src</span></code>)</p></li>
713713
<li><p class="sd-card-text">Update mentions of your repository name in other files (e.g. <code class="docutils literal notranslate"><span class="pre">README.md</span></code>)</p></li>
714714
</ul>

0 commit comments

Comments
 (0)