diff --git a/Makefile b/Makefile index 649d38b766..2ad8565e7f 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ CONDA := $(shell which conda) # Setup env for documents env-docs: - conda create --name $(DOC_ENV_NAME) --channel defaults python=$(PYTHON_VERSION) --yes + conda create --name $(DOC_ENV_NAME) --channel defaults python=$(PYTHON_VERSION) pip --yes $(CONDA) run --name $(DOC_ENV_NAME) pip install -r ./docs/requirements.txt .PHONY: $(MAKECMDGOALS) diff --git a/docs/source/resources/package-spec.rst b/docs/source/resources/package-spec.rst index f3b0643cc2..d06e180043 100644 --- a/docs/source/resources/package-spec.rst +++ b/docs/source/resources/package-spec.rst @@ -6,14 +6,26 @@ Conda package specification :local: :depth: 1 -A conda package is a bzipped tar archive---.tar.bz2---that -contains: +A conda package is an archive file that contains: * Metadata under the ``info/`` directory. * A collection of files that are installed directly into an install prefix. -The format is identical across platforms and operating systems. +There are currently two formats of archives that are supported: + +.. list-table:: + :widths: 15 70 + + * - **Type** + - **Description** + + * - .tar.bz2 + - The original format of conda packages. Is the default output of conda-build. + * - .conda + - 2nd Gen. This is a more compact and thus faster. Can be outputed from conda-build by setting output in ``.condarc`` file. + +The formats are identical across platforms and operating systems. During the install process, all files are extracted into the install prefix, with the exception of the ones in ``info/``. Installing a conda package into an environment is similar to @@ -47,7 +59,7 @@ file is stored in ``repodata.json``, which is the repository index file, hence the name ``index.json``. The JSON object is a dictionary containing the keys shown below. The filename of the conda package is composed of the first 3 values, as in: -``--.tar.bz2``. +``--.tar.bz2`` or ``--.conda``. .. list-table:: :widths: 15 15 70 diff --git a/news/4633-update-conda-package-docs b/news/4633-update-conda-package-docs new file mode 100644 index 0000000000..23a2833090 --- /dev/null +++ b/news/4633-update-conda-package-docs @@ -0,0 +1,19 @@ +### Enhancements + +* Added pip to env-doc make command so function would work correctly (pip is no longer added by default with python conda package). + +### Bug fixes + +* + +### Deprecations + +* + +### Docs + +* Updated pkg-spec docs to mention .conda package format. + +### Other + +*