Skip to content

Commit 3297907

Browse files
committed
deploy: 64b7cf6
1 parent 2cf97b4 commit 3297907

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

.doctrees/environment.pickle

1.21 KB
Binary file not shown.
Binary file not shown.

_sources/package-structure-code/pyproject-toml-python-package-metadata.md.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,12 @@ When you create your `pyproject.toml` file, there are numerous metadata fields t
139139

140140
[An overview of all of the project metadata elements can be found here.](https://packaging.python.org/en/latest/specifications/core-metadata/#project-url-multiple-use)
141141

142-
### Required fields for the [project] table
142+
### Required fields for the `[project]` table
143143

144-
As mentioned above, your pyproject.toml file needs to have a **name** and **version** field in order to properly build your package:
144+
As mentioned above, your `pyproject.toml` file needs to have a **`name`** and **`version`** field in order to properly build your package:
145145

146-
- Name: This is the name of your project provided as a string
147-
- Version: This is the version of your project. If you are using a scm tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).
146+
- `name`: This is the name of your project provided as a string
147+
- `version`: This is the version of your project. If you are using a SCM tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).
148148

149149
### Optional fields to include in the `[project]` table
150150

package-structure-code/pyproject-toml-python-package-metadata.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -582,11 +582,11 @@ <h2>Optional vs. Required pyproject.toml file fields<a class="headerlink" href="
582582
<p>When you create your <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file, there are numerous metadata fields that you can use. Below we suggest specific fields to get you started that support publication on PyPI and users finding your package.</p>
583583
<p><a class="reference external" href="https://packaging.python.org/en/latest/specifications/core-metadata/#project-url-multiple-use">An overview of all of the project metadata elements can be found here.</a></p>
584584
<section id="required-fields-for-the-project-table">
585-
<h3>Required fields for the [project] table<a class="headerlink" href="#required-fields-for-the-project-table" title="Link to this heading">#</a></h3>
586-
<p>As mentioned above, your pyproject.toml file needs to have a <strong>name</strong> and <strong>version</strong> field in order to properly build your package:</p>
585+
<h3>Required fields for the <code class="docutils literal notranslate"><span class="pre">[project]</span></code> table<a class="headerlink" href="#required-fields-for-the-project-table" title="Link to this heading">#</a></h3>
586+
<p>As mentioned above, your <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> file needs to have a <strong><code class="docutils literal notranslate"><span class="pre">name</span></code></strong> and <strong><code class="docutils literal notranslate"><span class="pre">version</span></code></strong> field in order to properly build your package:</p>
587587
<ul class="simple">
588-
<li><p>Name: This is the name of your project provided as a string</p></li>
589-
<li><p>Version: This is the version of your project. If you are using a scm tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).</p></li>
588+
<li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: This is the name of your project provided as a string</p></li>
589+
<li><p><code class="docutils literal notranslate"><span class="pre">version</span></code>: This is the version of your project. If you are using a SCM tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).</p></li>
590590
</ul>
591591
</section>
592592
<section id="optional-fields-to-include-in-the-project-table">
@@ -814,7 +814,7 @@ <h2>Example pyproject.toml for building using setuptools<a class="headerlink" hr
814814
</li>
815815
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#benefits-of-using-a-pyproject-toml-file">Benefits of using a pyproject.toml file</a></li>
816816
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#optional-vs-required-pyproject-toml-file-fields">Optional vs. Required pyproject.toml file fields</a><ul class="nav section-nav flex-column">
817-
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#required-fields-for-the-project-table">Required fields for the [project] table</a></li>
817+
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#required-fields-for-the-project-table">Required fields for the <code class="docutils literal notranslate"><span class="pre">[project]</span></code> table</a></li>
818818
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#optional-fields-to-include-in-the-project-table">Optional fields to include in the <code class="docutils literal notranslate"><span class="pre">[project]</span></code> table</a></li>
819819
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#advanced-options-in-the-pyproject-toml-file">Advanced options in the pyproject.toml file</a></li>
820820
</ul>

0 commit comments

Comments
 (0)