Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Issue/4633 #4929

Merged
merged 3 commits into from
Jul 10, 2023
Merged

Issue/4633 #4929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
850f027
Adding in pip so the makefile works correctly.
ryanskeith Jul 7, 2023
6894f43
Adding information about .conda format.
ryanskeith Jul 7, 2023
0f52886
Adding news.
ryanskeith Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
20 changes: 16 additions & 4 deletions docs/source/resources/package-spec.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

@dholth dholth Aug 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

outputted or singular output


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
Expand Down Expand Up @@ -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:
``<name>-<version>-<build>.tar.bz2``.
``<name>-<version>-<build>.tar.bz2`` or ``<name>-<version>-<build>.conda``.

.. list-table::
:widths: 15 15 70
Expand Down
19 changes: 19 additions & 0 deletions news/4633-update-conda-package-docs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

* <news item>

### Deprecations

* <news item>

### Docs

* Updated pkg-spec docs to mention .conda package format.

### Other

* <news item>