Todd Gamblin
fc748eb3d0
Exclude spack.__all__ from documentation.
...
Everything in the __all__ list in the spack module is from some other
module, so only do their documentation in their original location. This
also avoids issues like the fact that some directive names shadow spack
core module names.
2016-08-30 16:36:50 -05:00
Adam J. Stewart
9b455e9254
Resolve new documentation issues that have cropped up
2016-08-30 15:58:22 -05:00
Adam J. Stewart
8d1a753a1b
Fix spack --profile, fixes #1639
2016-08-30 15:35:58 -05:00
Adam J. Stewart
6795f4ca12
Use console instead of shell syntax lexer, fixes #1634
2016-08-30 15:35:58 -05:00
Adam J. Stewart
f78134efa5
Fixes #1620 , Missing references
2016-08-30 15:32:54 -05:00
Adam J. Stewart
02239c094e
Fix unexpected indentation in .rst files, #1612
2016-08-30 15:29:51 -05:00
Adam J. Stewart
0614bd206f
Fix #1608 , Include file not found
2016-08-30 15:28:09 -05:00
Adam J. Stewart
2326355497
Fix #1604 and fix #1605 , title underline problems
2016-08-30 15:28:08 -05:00
Adam J. Stewart
fda7fcd73d
Fix #1594 , duplicate explicit target name
2016-08-30 15:21:15 -05:00
Todd Gamblin
dae00fec29
Move all documentation generation into conf.py
...
- extra steps in Makefile are ignored by readthedocs
2016-08-30 00:47:04 -07:00
Massimiliano Culpo
3ecf4ef8c9
resources : added docs fixes #1551 ( #1627 )
2016-08-29 22:40:50 -07:00
Tyler Esser
83897af710
Documentation: Fix accidental quotation. version() takes expand as a keyword. ( #1640 )
2016-08-28 20:16:08 -07:00
Elizabeth Fischer
85be3aefa7
Put url_for_version() after versions in example.
2016-08-24 15:26:19 -04:00
citibeth
8a481e7e13
Added CMake-based Development case study to docuemntation.
2016-08-23 16:39:01 -04:00
citibeth
2efd7a5e0b
Added note on use of 'less -R' for colorized output.
2016-08-23 16:36:02 -04:00
Todd Gamblin
1e673bfa42
Don't assume spack is in the path when buildign docs.
2016-08-15 10:49:09 -07:00
Adam J. Stewart
c815aed207
Update documentation for spack md5
2016-08-12 10:51:56 -05:00
George Hartzell
4bca1c5440
Fix typo 'flexbile' -> 'flexible'
2016-08-09 15:13:08 -07:00
Todd Gamblin
098af17971
Merge pull request #1208 from paulhopkins/bugfix/github1196-specify-preferred-variants
...
Bugfix/github1196 specify preferred variants
2016-07-21 08:36:19 -07:00
Paul Hopkins
480fe9cb9a
Re-add documentation for variant preferences
2016-07-21 12:32:00 +01:00
Michael Kuhn
4e1f86881a
Update documentation for recursive module loading.
2016-07-21 13:15:10 +02:00
Todd Gamblin
8856a226c7
Merge pull request #1277 from mathstuf/special-deptypes
...
deptypes: support special deptypes by string
2016-07-20 13:15:57 -07:00
Gregory Becker
6983c1d30d
Documented linker default
2016-07-20 12:04:00 -07:00
Ben Boeckel
1315753e70
deptypes: support special deptypes by string
2016-07-19 16:26:18 -04:00
Todd Gamblin
117743863e
Merge pull request #1252 from hartzell/patch-5
...
Fix format of explanation of an example & question
2016-07-17 21:20:02 -07:00
Todd Gamblin
0e8bf79fa4
Merge pull request #1240 from epfl-scitas/truncated_documentation
...
doc : fixes #1239
2016-07-17 20:59:36 -07:00
alalazo
dc671ad037
docs : substituted None with empty cell
2016-07-17 22:17:52 +02:00
becker33
e822257565
Merge pull request #1251 from hartzell/patch-4
...
Minor typo fix
2016-07-15 13:51:02 -07:00
Ben Boeckel
45c675fe7f
spack: introduce dependency types
...
deptypes: allow for different queries
For things like Python modules, they are required for the build and
runtime, but rather than adding a new parameter for what to query across
the dependency DAG, just expose the recursive query parameter.
2016-07-14 16:21:46 -04:00
George Hartzell
3e718920d1
Remove extraneous letter 'p'
...
It got in there by mistake, now it's gone.
2016-07-14 09:40:47 -07:00
George Hartzell
3051c3d71d
Fix format of explanation of an example & question
...
This list was not formatted correctly on [the ReadTheDocs site](http://software.llnl.gov/spack/basic_usage.html#specs-dependencies ).
I'm not a .rst expert, but I think that it was improperly indented.
The example includes an `arch=...` string but *arch* is not listed in the valid compiler flag specifiers or architecture specifiers. Should it be, or is it considered an "optional variant specifier?
2016-07-14 08:31:07 -07:00
George Hartzell
e052aaf44d
Minor typo fix
...
the packages that depends on => the packages that depend on
2016-07-14 08:19:32 -07:00
alalazo
0e2afedb7f
doc : fixes #1239
2016-07-13 12:43:48 +02:00
Todd Gamblin
283d621b6e
Add documentation for fetching submodules.
2016-07-11 13:27:37 -07:00
Denis Davydov
306e601d4e
document special treatment of development version
2016-07-11 19:50:33 +02:00
Todd Gamblin
c086ccdab6
Merge pull request #1200 from glennpj/lowpackname
...
Have ``spack create`` default to lower case name for package
2016-07-08 13:29:52 -07:00
Glenn Johnson
33d0660abc
Have `spack create
` default to lower case name
...
This will create package directories with lower case names when using
`spack create`. The documentation was modified to reflect this.
2016-07-08 15:11:37 -05:00
George Hartzell
1b9e8a0e65
Fix typo
...
Comamnds -> Commands
2016-07-08 11:01:08 -07:00
Todd Gamblin
b9148b1751
Merge pull request #1125 from NERSC/docs/cray
...
Update documentation for use on Cray
2016-07-06 15:06:20 -07:00
Mario Melara
56adb5d9a5
Change arch spec and fix typo
...
Changed old arch specs to new arch specs. Changed intallation to
installation
2016-06-30 17:03:07 -07:00
Mario Melara
16a4c49f98
Remove Cray examples of config files
...
Removed examples of Cray config files and added them under Spack on
Cray. Any users of Cray can just look at the Spack on Cray section to
get an idea of what's used. If they want more information they can click
links to the sections.
2016-06-30 17:01:18 -07:00
Mario Melara
d784d561fc
Add more documentation fix arch spec
...
Added more documentation for Spack on Cray. Also fixed the architecture
spec to be linux-debian7-x86_64 since it was reversed in the previous
commit.
2016-06-30 16:59:36 -07:00
Elizabeth Fischer
50ac98bc04
Merge remote-tracking branch 'upstream/develop' into efischer/160630-StagedPackage
...
# Conflicts:
# lib/spack/docs/packaging_guide.rst
# lib/spack/spack/package.py
Mostly minor/formatting issues in lib/spack/spack/package.py (the heavyweight merge was already done recently). Only one serious issue: it looks like the feature branch had accidentally deleted the line `spack.hooks.post_install(self)`. This got added back in from develop.
2016-06-30 09:13:24 -04:00
Todd Gamblin
0e422dec8c
Merge pull request #1141 from adamjstewart/fixes/license_docs
...
Fix missing code blocks in licensed software documentation
2016-06-30 02:22:38 -07:00
Todd Gamblin
bc2fa76588
Merge pull request #1146 from scheibelp/features/doc-caching
...
added documentation for automatic caching of resources fetched during installs
2016-06-30 02:13:16 -07:00
Todd Gamblin
30d083c6b7
Merge branch 'efischer/160401-RecursiveModules' of https://github.com/citibeth/spack into citibeth-efischer/160401-RecursiveModules
2016-06-30 02:12:00 -07:00
Peter Scheibel
cfd380d514
added documentation for automatic caching of resources fetched during installs
2016-06-29 18:23:40 -07:00
Adam J. Stewart
06de8c56af
Fix missing code blocks in licensed software documentation
2016-06-29 12:35:38 -05:00
Mario Melara
26325fe812
Add missing link to external packages
...
Adding missing _sec-external_packages to link with external packages
page
2016-06-27 14:35:56 -07:00
Mario Melara
7fb45e4bfd
Update documentation for use on Cray
...
Updating how to use compilers.yaml on Cray as well as setting up
external packages. Also includes what needs to be set up for usage on
Cray and explains what needs to be done to get Spack properly working.
Also explain the architecture spec and what it does.
2016-06-27 13:52:48 -07:00