spack/lib/spack/docs/index.rst
Omar Padron 3a9cd2614e Docker-Based Developer Resource (#5871)
* add docker-based development resources

* incorporate feedback from @ax3l

* fix docs/improve ssh handling

* experiment with custom prompt

* add arch/fix missing core_compilers key

* add centos/minor tweaks

* make prompt experiment optional

* workaround problem with latest fedora docker image

* add docker documentation page to index toc

* try another documentation fix

* switch arch linux base to base/archlinux

* update the git urls in the Dockerfiles

* add opensuse

* switch CUSTOM_PROMPT variable to simply "PROMPT"
2018-02-27 00:36:14 -08:00

87 lines
2.2 KiB
ReStructuredText

.. Spack documentation master file, created by
sphinx-quickstart on Mon Dec 9 15:32:41 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
===================
Spack
===================
.. epigraph::
`These are docs for the Spack package manager. For sphere packing, see` `pyspack <https://pyspack.readthedocs.io>`_.
Spack is a package management tool designed to support multiple
versions and configurations of software on a wide variety of platforms
and environments. It was designed for large supercomputing centers,
where many users and application teams share common installations of
software on clusters with exotic architectures, using libraries that
do not have a standard ABI. Spack is non-destructive: installing a
new version does not break existing installations, so many
configurations can coexist on the same system.
Most importantly, Spack is *simple*. It offers a simple *spec* syntax
so that users can specify versions and configuration options
concisely. Spack is also simple for package authors: package files
are written in pure Python, and specs allow package authors to
maintain a single file for many different builds of the same package.
See the :doc:`features` for examples and highlights.
Get spack from the `github repository
<https://github.com/spack/spack>`_ and install your first
package:
.. code-block:: console
$ git clone https://github.com/spack/spack.git
$ cd spack/bin
$ ./spack install libelf
If you're new to spack and want to start using it, see :doc:`getting_started`,
or refer to the full manual below.
.. toctree::
:maxdepth: 2
:caption: Basics
features
getting_started
basic_usage
workflows
tutorial
known_issues
.. toctree::
:maxdepth: 2
:caption: Reference
configuration
config_yaml
build_settings
mirrors
module_file_support
repositories
binary_caches
command_index
package_list
.. toctree::
:maxdepth: 2
:caption: Contributing
contribution_guide
packaging_guide
developer_guide
docker_for_developers
Spack API Docs <spack>
LLNL API Docs <llnl>
==================
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`