document conda-build: pkg_format: 2 (conda#11881)

* document conda-build: pkg_format: 2 * Apply suggestions from code review Co-authored-by: Katherine Kinnaman <[email protected]>
xylar · Sep 27, 2022 · 6918d6f · 6918d6f
1 parent dbf08f0
commit 6918d6f
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/source/user-guide/configuration/use-condarc.rst b/docs/source/user-guide/configuration/use-condarc.rst
@@ -697,6 +697,7 @@ Conda-build configuration
 
 * :ref:`specify-root-dir`
 * :ref:`specify-output-folder`
+* :ref:`pkg_format`
 * :ref:`auto-upload`
 * :ref:`anaconda-token`
 * :ref:`quiet`
@@ -745,6 +746,18 @@ the root build directory (``root-dir``).
    conda-build:
        output_folder: conda-bld
 
+.. pkg_format:
+
+Specify conda-build package version (pkg_version)
+-------------------------------------------------
+
+Conda package version to create. Use ``2`` for ``.conda`` packages. If not set, conda-build defaults to ``.tar.bz2``.
+
+.. code-block:: yaml
+
+   conda-build:
+      pkg_format: 2
+
 .. _auto-upload:
 
 Automatically upload conda-build packages to Anaconda.org (anaconda_upload)