Skip to content

Commit 9e552b9

Browse files
committed
Updated user guide, deleted Overview, minor clean up
1 parent f1e707c commit 9e552b9

File tree

5 files changed

+38
-21
lines changed

5 files changed

+38
-21
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
========
2-
Overview
3-
========
4-
5-
This page provides an overview of how to use conda. For an
6-
overview of what conda is and what it does, please see the
7-
:doc:`front page <../index>`. Look over the :doc:`concepts guide <../user-guide/concepts/index>`
8-
to learn more about the foundations of conda.
9-
10-
The quickest way to start using conda is to go through the
11-
20-minute :doc:`getting-started` guide.
1+
==============
2+
Conda commands
3+
==============
124

135
The ``conda`` command is the primary interface for managing
146
installations of various packages. It can:
@@ -27,7 +19,6 @@ installations of various packages. It can:
2719
``--envs`` and ``-e`` are the same.
2820

2921
For full usage of each command, including abbreviations, see
30-
:doc:`../commands`. You can see the same information at the
22+
:doc:`../../commands`. You can see the same information at the
3123
command line by :doc:`viewing the command-line help
32-
<tasks/view-command-line-help>`.
33-
24+
<../tasks/view-command-line-help>`.

docs/source/user-guide/concepts/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Explore the links to learn more about conda foundations.
77
.. toctree::
88
:maxdepth: 1
99

10+
conda-commands
1011
packages
1112
pkg-specs
1213
channels

docs/source/user-guide/concepts/installing-with-conda.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,5 @@ Learn more about `package specifications and metadata <https://docs.conda.io/pro
7575

7676
For example, if you want to install llvmlite 0.31.0dev0 on Python 3.7.8, you
7777
would enter::
78-
conda install -c numba/label/dev llvmlite=0.31.0dev0=py37_8
78+
79+
conda install -c numba/label/dev llvmlite=0.31.0dev0=py37_8

docs/source/user-guide/index.rst

+25-2
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,35 @@ User guide
44

55
.. toctree::
66
:maxdepth: 1
7-
8-
overview
7+
:hidden:
8+
99
concepts/index
1010
getting-started
1111
install/index
1212
configuration/index
1313
tasks/index
1414
cheatsheet
1515
troubleshooting
16+
17+
:doc:`Home <../index>` | :doc:`Concepts <concepts/index>` | :doc:`Getting started <getting-started>` | :doc:`Installation <install/index>` | :doc:`Configuration <configuration/index>` | :doc:`Tasks <tasks/index>` | :ref:`Additional resources <addl-resources>`
18+
19+
**Get started**
20+
21+
* :doc:`See what conda is and what it does <../index>`.
22+
* :doc:`Learn conda concepts and fundamentals <concepts/index>`.
23+
* :doc:`Create your first conda project in 20 minutes <getting-started>`.
24+
* :doc:`View system requirements and installation directions <install/index>`.
25+
26+
27+
**Dive deeper**
28+
29+
* :doc:`Configure your conda files <configuration/index>`.
30+
* Follow the :doc:`tasks <tasks/index>` to :doc:`manage conda environments <tasks/manage-environments>`, :doc:`channels <tasks/manage-channels>`, :doc:`packages<tasks/manage-pkgs>`, and more.
31+
32+
33+
.. _addl-resources:
34+
35+
**Additional resources**
36+
37+
* :doc:`Cheat sheet <cheatsheet>`.
38+
* :doc:`Troubleshooting <troubleshooting>`.

docs/source/user-guide/install/index.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Installation
99
The fastest way to :doc:`obtain <download>` conda is to install
1010
:ref:`Miniconda <miniconda-glossary>`, a mini version of
1111
:ref:`Anaconda <anaconda-glossary>` that includes only conda and
12-
its dependencies. If you prefer to have conda plus over 720 open
13-
source packages, install Anaconda.
12+
its dependencies. If you prefer to have conda plus over 720 open-source
13+
packages, install Anaconda.
1414

1515
We recommend you install Anaconda for the local user, which does
1616
not require administrator permissions and is the most robust
@@ -21,6 +21,7 @@ For information on using our graphical installers for
2121
Windows or macOS, see the instructions for
2222
`installing Anaconda <http://docs.continuum.io/anaconda/install.html>`_.
2323

24+
.. _system-reqs:
2425

2526
System requirements
2627
===================
@@ -32,9 +33,9 @@ System requirements
3233
* For Anaconda---Minimum 3 GB disk space to download and install.
3334

3435

35-
* Windows, macOS or Linux.
36+
* Windows, macOS, or Linux.
3637

37-
* Python 2.7, 3.4, 3.5 or 3.6.
38+
* Python 2.7, 3.4, 3.5, or 3.6.
3839
* pycosat.
3940
* PyYaml.
4041
* Requests.

0 commit comments

Comments
 (0)