deploy: 3db156e

Author: willingc

.doctrees/environment.pickle

@@ -258,7 +258,7 @@ pyospackage/
        ├── add_numbers.py
 ```
 
-## Step 3. Add code to your `add_numbers.py` module
+## Step 3: Add code to your `add_numbers.py` module
 
 If you are following along and making a Python package from scratch then you can add the code below to your `add_numbers.py` module. The function below adds two integers together and returns the result. Notice that the code below has a few features that we will review in future tutorials:
 
@@ -298,7 +298,7 @@ def add_num(a: int, b: int) -> int:
     return a + b
 ```
 
-## Step 4. Modify metadata in your `pyproject.toml` file
+## Step 4: Modify metadata in your `pyproject.toml` file
 
 Next, you will modify some of the metadata (information) that
 Hatch adds to your `pyproject.toml` file. You are
@@ -404,7 +404,7 @@ You will learn how to automate defining a package
 version using git tags in the version and release your package lesson.
 :::
 
-### Step 3: Adjust your project classifiers
+### Adjust project classifiers
 
 Hatch by default provides a list of classifiers that define what
 Python versions your package supports. While this won't impact your package build, let's remove some of them that you likely don't need.
@@ -464,7 +464,7 @@ Once you have your project metadata in the pyproject.toml file, you will
 rarely update it. In the next lesson you’ll add more metadata and structure to this file.
 :::
 
-## Step 5. Install your package locally
+## Step 5: Install your package locally
 
 At this point you should have:
 
@@ -564,7 +564,7 @@ pyosPackage                   0.1.0          /Users/yourusername/path/here/pyosP
 ...
 ```
 
-## 6. Test out your new package
+## Step 6: Test out your new package
 
 After installing your package, type “python” at the command prompt in your chosen terminal to start
 a Python session in your active Python environment.

.doctrees/tutorials/1-installable-code.doctree

@@ -742,7 +742,7 @@ <h2>Step 2: Add code to your package<a class="headerlink" href="#step-2-add-code
 </div>
 </section>
 <section id="step-3-add-code-to-your-add-numbers-py-module">
-<h2>Step 3. Add code to your <code class="docutils literal notranslate"><span class="pre">add_numbers.py</span></code> module<a class="headerlink" href="#step-3-add-code-to-your-add-numbers-py-module" title="Link to this heading">#</a></h2>
+<h2>Step 3: Add code to your <code class="docutils literal notranslate"><span class="pre">add_numbers.py</span></code> module<a class="headerlink" href="#step-3-add-code-to-your-add-numbers-py-module" title="Link to this heading">#</a></h2>
 <p>If you are following along and making a Python package from scratch then you can add the code below to your <code class="docutils literal notranslate"><span class="pre">add_numbers.py</span></code> module. The function below adds two integers together and returns the result. Notice that the code below has a few features that we will review in future tutorials:</p>
 <ol class="arabic simple">
 <li><p>It has a <a class="reference internal" href="../documentation/write-user-documentation/document-your-code-api-docstrings.html#numpy-docstring"><span class="std std-ref">numpy-style docstring</span></a></p></li>
@@ -779,7 +779,7 @@ <h2>Step 3. Add code to your <code class="docutils literal notranslate"><span cl
 </div>
 </section>
 <section id="step-4-modify-metadata-in-your-pyproject-toml-file">
-<h2>Step 4. Modify metadata in your <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file<a class="headerlink" href="#step-4-modify-metadata-in-your-pyproject-toml-file" title="Link to this heading">#</a></h2>
+<h2>Step 4: Modify metadata in your <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file<a class="headerlink" href="#step-4-modify-metadata-in-your-pyproject-toml-file" title="Link to this heading">#</a></h2>
 <p>Next, you will modify some of the metadata (information) that
 Hatch adds to your <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file. You are
 are welcome to copy the file we have in our <a class="reference external" href="https://github.com/pyOpenSci/pyosPackage">example pyospackage GitHub repository</a>.</p>
@@ -866,8 +866,8 @@ <h2>Step 4. Modify metadata in your <code class="docutils literal notranslate"><
 <span class="n">path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;src/pyospackage/__about__.py&quot;</span>
 </pre></div>
 </div>
-<section id="step-3-adjust-your-project-classifiers">
-<h3>Step 3: Adjust your project classifiers<a class="headerlink" href="#step-3-adjust-your-project-classifiers" title="Link to this heading">#</a></h3>
+<section id="adjust-project-classifiers">
+<h3>Adjust project classifiers<a class="headerlink" href="#adjust-project-classifiers" title="Link to this heading">#</a></h3>
 <p>Hatch by default provides a list of classifiers that define what
 Python versions your package supports. While this won’t impact your package build, let’s remove some of them that you likely don’t need.</p>
 <ul class="simple">
@@ -921,7 +921,7 @@ <h3>Step 3: Adjust your project classifiers<a class="headerlink" href="#step-3-a
 </section>
 </section>
 <section id="step-5-install-your-package-locally">
-<h2>Step 5. Install your package locally<a class="headerlink" href="#step-5-install-your-package-locally" title="Link to this heading">#</a></h2>
+<h2>Step 5: Install your package locally<a class="headerlink" href="#step-5-install-your-package-locally" title="Link to this heading">#</a></h2>
 <p>At this point you should have:</p>
 <ol class="arabic simple">
 <li><p>A project directory structure with a <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file at the root</p></li>
@@ -1007,8 +1007,8 @@ <h3>Look for pyospackage in your environment<a class="headerlink" href="#look-fo
 </div>
 </section>
 </section>
-<section id="test-out-your-new-package">
-<h2>6. Test out your new package<a class="headerlink" href="#test-out-your-new-package" title="Link to this heading">#</a></h2>
+<section id="step-6-test-out-your-new-package">
+<h2>Step 6: Test out your new package<a class="headerlink" href="#step-6-test-out-your-new-package" title="Link to this heading">#</a></h2>
 <p>After installing your package, type “python” at the command prompt in your chosen terminal to start
 a Python session in your active Python environment.</p>
 <p>You can now import your package and access the <code class="docutils literal notranslate"><span class="pre">add_num</span></code> function.</p>
@@ -1135,16 +1135,16 @@ <h2>Footnotes<a class="headerlink" href="#footnotes" title="Link to this heading
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#time-to-create-your-python-package">Time to create your Python package!</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-set-up-the-package-directory-structure">Step 1: Set Up the Package Directory Structure</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-add-code-to-your-package">Step 2: Add code to your package</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-add-code-to-your-add-numbers-py-module">Step 3. Add code to your <code class="docutils literal notranslate"><span class="pre">add_numbers.py</span></code> module</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-4-modify-metadata-in-your-pyproject-toml-file">Step 4. Modify metadata in your <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file</a><ul class="nav section-nav flex-column">
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-adjust-your-project-classifiers">Step 3: Adjust your project classifiers</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-add-code-to-your-add-numbers-py-module">Step 3: Add code to your <code class="docutils literal notranslate"><span class="pre">add_numbers.py</span></code> module</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-4-modify-metadata-in-your-pyproject-toml-file">Step 4: Modify metadata in your <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#adjust-project-classifiers">Adjust project classifiers</a></li>
 </ul>
 </li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-5-install-your-package-locally">Step 5. Install your package locally</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-5-install-your-package-locally">Step 5: Install your package locally</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#look-for-pyospackage-in-your-environment">Look for pyospackage in your environment</a></li>
 </ul>
 </li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#test-out-your-new-package">6. Test out your new package</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#step-6-test-out-your-new-package">Step 6: Test out your new package</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#congratulations-you-created-your-first-python-package">Congratulations! You created your first Python package</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#footnotes">Footnotes</a></li>
 </ul>