Skip to content

Commit

Permalink
Added cheatsheet PDF download to cheatsheet page (conda#13909)
Browse files Browse the repository at this point in the history
* Added cheatsheet PDF download to cheatsheet page

* Added news item

* Added version to original PDF and updated symlink

* Corrected cheatsheet naming convention

* Adding old PDFs and links back in to cheatsheet page
  • Loading branch information
kathatherine authored May 16, 2024
1 parent eb45954 commit 49f2614
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 2 deletions.
44 changes: 43 additions & 1 deletion docs/source/user-guide/cheatsheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,33 @@
Cheatsheet
==========

Refer to the conda cheatsheet for basic commands for creating and managing environments, installing packages, and importing and exporting environments.
The conda cheatsheet contains the most important information about using conda, such as basic commands for creating and managing environments, installing packages, and importing and exporting environments.

See the :download:`conda cheatsheet <conda-cheatsheet.pdf>` PDF (3 MB) for a downloadable, single-page version.

**Versions**

..
Maintainers! When updating the following list, please make sure to
update the filesystem symlink "conda-cheatsheet.pdf" to the latest
version as well, to keep the URL of the conda cheetsheet the same.
Thank you!
- :download:`conda 24.4.0 <cheatsheets/conda-24.4.0.pdf>` (latest)

- :download:`conda 4.14.x <cheatsheets/conda-4.14.pdf>`

- :download:`conda 4.12.x <cheatsheets/conda-4.12.pdf>`

- :download:`conda 4.6.x <cheatsheets/conda-4.6.pdf>`

Quickstart
==========

.. tip::

It is recommended to create a new environment for any new project or workflow.

.. csv-table::
:widths: 42 58
:header-rows: 0
Expand All @@ -15,6 +37,10 @@ Quickstart
Channels and Packages
=====================

.. tip::

Package dependencies and platform specifics are automatically resolved when using conda.

.. csv-table::
:widths: 42 58
:header-rows: 0
Expand All @@ -23,6 +49,10 @@ Channels and Packages
Working with Conda Environments
===============================

.. tip::

List environments at the beginning of your session. Environments with an asterisk are active.

.. csv-table::
:widths: 42 58
:header-rows: 0
Expand All @@ -31,6 +61,10 @@ Working with Conda Environments
Environment Management
======================

.. tip::

Specifying the environment name confines conda commands to that environment.

.. csv-table::
:widths: 42 58
:header-rows: 0
Expand All @@ -39,6 +73,10 @@ Environment Management
Exporting Environments
======================

.. tip::

Name your export file after your environment to preserve your environment name.

.. csv-table::
:widths: 42 58
:header-rows: 0
Expand All @@ -47,6 +85,10 @@ Exporting Environments
Importing Environments
======================

.. tip::

When importing an environment, conda resolves platform and package specifics.

.. csv-table::
:widths: 42 58
:header-rows: 0
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/source/user-guide/cheatsheets/conda-4.6.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/source/user-guide/conda-cheatsheet.pdf
19 changes: 19 additions & 0 deletions news/13909-add-cheatsheet-pdf
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Enhancements

* <news item>

### Bug fixes

* <news item>

### Deprecations

* <news item>

### Docs

* Added cheatsheet PDF download to cheatsheet page. (#13909)

### Other

* <news item>

0 comments on commit 49f2614

Please sign in to comment.