mamba/docs/source/index.rst

79 lines
2.0 KiB
ReStructuredText

Welcome to Mamba's documentation!
=================================
Mamba is a fast, robust, and cross-platform package manager.
It runs on Windows, OS X and Linux (ARM64 and PPC64LE included) and is fully compatible with ``conda`` packages and supports most of conda's commands.
Mamba is a framework with several components:
- ``libmamba``: a C++ library of the domain, exposing low-level and high-level APIs
- ``mamba``: a ELF as a *drop-in* replacement for ``conda``, built on top of ``libmamba``
- ``micromamba``: the statically linked version of ``mamba``
- ``libmambapy``: python bindings of ``libmamba``
.. note::
In this documentation, ``Mamba`` will refer to all flavors while flavor-specific details will mention ``mamba``, ``micromamba`` or ``libmamba``.
.. note::
:ref:`micromamba<micromamba>` is especially well fitted for the CI use-case but not limited to that!
You can try Mamba now by visiting the installation for
:ref:`mamba<mamba-install>` or :ref:`micromamba<umamba-install>`
.. toctree::
:caption: INSTALLATION
:maxdepth: 2
:hidden:
Mamba <installation/mamba-installation>
Micromamba <installation/micromamba-installation>
.. toctree::
:caption: USER GUIDE
:maxdepth: 2
:hidden:
user_guide/concepts
Mamba <user_guide/mamba>
Micromamba <user_guide/micromamba>
user_guide/configuration
user_guide/troubleshooting
.. toctree::
:caption: ADVANCED USAGE
:maxdepth: 2
:hidden:
advanced_usage/more_concepts
advanced_usage/detailed_operations
advanced_usage/artifacts_verification
advanced_usage/package_resolution
.. toctree::
:caption: LIBMAMBA USAGE
:maxdepth: 2
:hidden:
usage/specs
usage/solver
.. toctree::
:caption: API REFERENCE
:maxdepth: 2
:hidden:
api/specs
api/solver
.. toctree::
:caption: DEVELOPER ZONE
:maxdepth: 2
:hidden:
developer_zone/contributing
developer_zone/dev_environment
developer_zone/internals
developer_zone/changes-2.0