deploy: ce38ab7

pyOpenSci · Sep 12, 2023 · c07441c · c07441c
1 parent 5c82617
commit c07441c
Show file tree

Hide file tree

Showing 36 changed files with 8 additions and 8 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/package-structure-code/code-style-linting-format.doctree b/.doctrees/package-structure-code/code-style-linting-format.doctree
diff --git a/.doctrees/package-structure-code/python-package-structure.doctree b/.doctrees/package-structure-code/python-package-structure.doctree
diff --git a/_images/social_previews/summary_CONTRIBUTING_c433f30d.png b/_images/social_previews/summary_CONTRIBUTING_c433f30d.png
diff --git a/_images/social_previews/summary_ci-and-testing_intro_a30242e8.png b/_images/social_previews/summary_ci-and-testing_intro_a30242e8.png
diff --git a/_images/social_previews/summary_documentation_hosting-tools_intro_ca1a55d8.png b/_images/social_previews/summary_documentation_hosting-tools_intro_ca1a55d8.png
diff --git a/...s/summary_documentation_hosting-tools_myst-markdown-rst-doc-syntax_da811838.png b/...s/summary_documentation_hosting-tools_myst-markdown-rst-doc-syntax_da811838.png
diff --git a/...s/summary_documentation_hosting-tools_publish-documentation-online_5095365b.png b/...s/summary_documentation_hosting-tools_publish-documentation-online_5095365b.png
diff --git a/...umentation_hosting-tools_sphinx-python-package-documentation-tools_0b92015f.png b/...umentation_hosting-tools_sphinx-python-package-documentation-tools_0b92015f.png
diff --git a/...y_documentation_hosting-tools_website-hosting-optimizing-your-docs_077c0ef2.png b/...y_documentation_hosting-tools_website-hosting-optimizing-your-docs_077c0ef2.png
diff --git a/_images/social_previews/summary_documentation_index_234ecf2d.png b/_images/social_previews/summary_documentation_index_234ecf2d.png
diff --git a/...eviews/summary_documentation_repository-files_code-of-conduct-file_9e54b2bf.png b/...eviews/summary_documentation_repository-files_code-of-conduct-file_9e54b2bf.png
diff --git a/..._previews/summary_documentation_repository-files_contributing-file_7650bedb.png b/..._previews/summary_documentation_repository-files_contributing-file_7650bedb.png
diff --git a/..._previews/summary_documentation_repository-files_development-guide_0ebdb24f.png b/..._previews/summary_documentation_repository-files_development-guide_0ebdb24f.png
diff --git a/_images/social_previews/summary_documentation_repository-files_intro_2d12c6f4.png b/_images/social_previews/summary_documentation_repository-files_intro_2d12c6f4.png
diff --git a/...cial_previews/summary_documentation_repository-files_license-files_78519ab6.png b/...cial_previews/summary_documentation_repository-files_license-files_78519ab6.png
diff --git a/.../summary_documentation_repository-files_readme-file-best-practices_62fcedf7.png b/.../summary_documentation_repository-files_readme-file-best-practices_62fcedf7.png
diff --git a/...ry_documentation_write-user-documentation_create-package-tutorials_e963eee3.png b/...ry_documentation_write-user-documentation_create-package-tutorials_e963eee3.png
diff --git a/...ntation_write-user-documentation_document-your-code-api-docstrings_6530669a.png b/...ntation_write-user-documentation_document-your-code-api-docstrings_6530669a.png
diff --git a/...reviews/summary_documentation_write-user-documentation_get-started_655e1bad.png b/...reviews/summary_documentation_write-user-documentation_get-started_655e1bad.png
diff --git a/...cial_previews/summary_documentation_write-user-documentation_intro_073efb6a.png b/...cial_previews/summary_documentation_write-user-documentation_intro_073efb6a.png
diff --git a/_images/social_previews/summary_index_f00605b5.png b/_images/social_previews/summary_index_f00605b5.png
diff --git a/..._previews/summary_package-structure-code_code-style-linting-format_a195a5b9.png b/..._previews/summary_package-structure-code_code-style-linting-format_a195a5b9.png
diff --git a/...views/summary_package-structure-code_complex-python-package-builds_d5505a31.png b/...views/summary_package-structure-code_complex-python-package-builds_d5505a31.png
diff --git a/_images/social_previews/summary_package-structure-code_intro_3894ec6c.png b/_images/social_previews/summary_package-structure-code_intro_3894ec6c.png
diff --git a/...s/summary_package-structure-code_publish-python-package-pypi-conda_b5c69e7a.png b/...s/summary_package-structure-code_publish-python-package-pypi-conda_b5c69e7a.png
diff --git a/...mary_package-structure-code_pyproject-toml-python-package-metadata_4fb05649.png b/...mary_package-structure-code_pyproject-toml-python-package-metadata_4fb05649.png
diff --git a/...previews/summary_package-structure-code_python-package-build-tools_e4008c3a.png b/...previews/summary_package-structure-code_python-package-build-tools_e4008c3a.png
diff --git a/...ckage-structure-code_python-package-distribution-files-sdist-wheel_714f58ff.png b/...ckage-structure-code_python-package-distribution-files-sdist-wheel_714f58ff.png
diff --git a/...l_previews/summary_package-structure-code_python-package-structure_8a84082a.png b/...l_previews/summary_package-structure-code_python-package-structure_8a84082a.png
diff --git a/...al_previews/summary_package-structure-code_python-package-versions_3b291cf3.png b/...al_previews/summary_package-structure-code_python-package-versions_3b291cf3.png
diff --git a/_images/social_previews/summary_python-packaging_intro_93d8367c.png b/_images/social_previews/summary_python-packaging_intro_93d8367c.png
diff --git a/_sources/package-structure-code/code-style-linting-format.md.txt b/_sources/package-structure-code/code-style-linting-format.md.txt
@@ -201,7 +201,7 @@ from stravalib import unithelper as uh
 
 [Ruff](https://beta.ruff.rs) is a new addition to the code quality ecosystem,
 gaining some traction since its release.
-`ruff` is a linter for Python, aiming to replace several tools behind a single interface.  
+`ruff` is a linter for Python, aiming to replace several tools behind a single interface.
 As such, `ruff` can be used instead of `flake8` and `isort`.
 
 `ruff` has some interesting features that distinguish it from other linters:

diff --git a/_sources/package-structure-code/python-package-structure.md.txt b/_sources/package-structure-code/python-package-structure.md.txt
@@ -96,7 +96,7 @@ If `tests/` are outside of the **src/package** directory, they aren't included i
 
 By default, Python adds a module in your current working directory to the front of the Python module search path.
 
-This means that if you run your tests in your packages working directory, using a flat layout, `/package/module.py`, Python will discover `package-name/module.py` file before it discovers the installed package.
+This means that if you run your tests in your package's working directory, using a flat layout, `/package/module.py`, Python will discover `package/module.py` file before it discovers the installed package.
 
 However, if your package lives in a src/ directory structure **src/package** then it won't be, by default, added to the Python path. This means that when you import your package, Python will be forced to  search the active environment (which has your package installed).
 
@@ -109,7 +109,7 @@ We do not recommend including tests as part of your package wheel by default. Ho
 
 ```bash
 src/
-  package-name/
+  package/
     tests/
 docs/
 ```
@@ -185,7 +185,7 @@ The flat layout's primary characteristics are:
 
 - The source code for your package lives in a directory with your package's
   name in the root of your directory
-- Often the `tests/` directory also lives within that same `package-name` directory.
+- Often the `tests/` directory also lives within that same `package` directory.
 
 Below you can see the recommended structure of a scientific Python package
 using the flat layout.

diff --git a/package-structure-code/code-style-linting-format.html b/package-structure-code/code-style-linting-format.html
@@ -715,7 +715,7 @@ <h4>Example application of isort<a class="headerlink" href="#example-application
 <h3>Ruff<a class="headerlink" href="#ruff" title="Permalink to this heading">#</a></h3>
 <p><a class="reference external" href="https://beta.ruff.rs">Ruff</a> is a new addition to the code quality ecosystem,
 gaining some traction since its release.
-<code class="docutils literal notranslate"><span class="pre">ruff</span></code> is a linter for Python, aiming to replace several tools behind a single interface.<br />
+<code class="docutils literal notranslate"><span class="pre">ruff</span></code> is a linter for Python, aiming to replace several tools behind a single interface.
 As such, <code class="docutils literal notranslate"><span class="pre">ruff</span></code> can be used instead of <code class="docutils literal notranslate"><span class="pre">flake8</span></code> and <code class="docutils literal notranslate"><span class="pre">isort</span></code>.</p>
 <p><code class="docutils literal notranslate"><span class="pre">ruff</span></code> has some interesting features that distinguish it from other linters:</p>
 <ul class="simple">

diff --git a/package-structure-code/python-package-structure.html b/package-structure-code/python-package-structure.html
@@ -613,15 +613,15 @@ <h2>The src/ layout and testing<a class="headerlink" href="#the-src-layout-and-t
 <div class="admonition-how-python-discovers-and-prioritizes-importing-modules admonition">
 <p class="admonition-title">How Python discovers and prioritizes importing modules</p>
 <p>By default, Python adds a module in your current working directory to the front of the Python module search path.</p>
-<p>This means that if you run your tests in your packages working directory, using a flat layout, <code class="docutils literal notranslate"><span class="pre">/package/module.py</span></code>, Python will discover <code class="docutils literal notranslate"><span class="pre">package-name/module.py</span></code> file before it discovers the installed package.</p>
+<p>This means that if you run your tests in your package’s working directory, using a flat layout, <code class="docutils literal notranslate"><span class="pre">/package/module.py</span></code>, Python will discover <code class="docutils literal notranslate"><span class="pre">package/module.py</span></code> file before it discovers the installed package.</p>
 <p>However, if your package lives in a src/ directory structure <strong>src/package</strong> then it won’t be, by default, added to the Python path. This means that when you import your package, Python will be forced to  search the active environment (which has your package installed).</p>
 <p>Note: Python versions 3.11 and above have a path setting that can be adjusted to ensure the priority is to use installed packages first (e.g. <code class="docutils literal notranslate"><span class="pre">PYTHONSAFEPATH</span></code>).</p>
 </div>
 <section id="sometimes-tests-are-needed-in-a-distribution">
 <h3>Sometimes tests are needed in a distribution<a class="headerlink" href="#sometimes-tests-are-needed-in-a-distribution" title="Permalink to this heading">#</a></h3>
 <p>We do not recommend including tests as part of your package wheel by default. However, not including tests in your package distribution will make it harder for people other than yourself to test whether your package is functioning correctly on their system. If you have a small test suite (Python files + data), and think your users may want to run tests locally on their systems, you can include tests by moving the <code class="docutils literal notranslate"><span class="pre">tests/</span></code> directory into the <strong>src/package</strong> directory (see example below).</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>src/
-<span class="w">  </span>package-name/
+<span class="w">  </span>package/
 <span class="w">    </span>tests/
 docs/
 </pre></div>
@@ -692,7 +692,7 @@ <h2>What does the flat layout structure look like?<a class="headerlink" href="#w
 <ul class="simple">
 <li><p>The source code for your package lives in a directory with your package’s
 name in the root of your directory</p></li>
-<li><p>Often the <code class="docutils literal notranslate"><span class="pre">tests/</span></code> directory also lives within that same <code class="docutils literal notranslate"><span class="pre">package-name</span></code> directory.</p></li>
+<li><p>Often the <code class="docutils literal notranslate"><span class="pre">tests/</span></code> directory also lives within that same <code class="docutils literal notranslate"><span class="pre">package</span></code> directory.</p></li>
 </ul>
 <p>Below you can see the recommended structure of a scientific Python package
 using the flat layout.</p>