spack/lib/spack/docs
Harmen Stoppels 2b4f2daa73
package API v2.0: new repo layout (#49256)
This implements Package API v2.0, and is an opt-in feature for repos. It can be enabled with

```yaml
repo:
  ...
  api: v2.0
```

It differs from the current default v1.0 as follows:

1. Package names can only contain `-` as a separator.
2. Package names can only be lowercase.
3. Package directory names are valid Python module names.
4. The repo namespace and its directory name are the same.
5. The `packages` subdir, which is configurable, should be a directory
   name that is also a valid Python module name.
6. There is a one to one mapping between Spack package names and Python
   module names.
7. Import statements `import spack.pkg.namespace.package_module` in
   `package.py` files need to specify the canonical package module.

To go from Spack package name to Python module name:
- Replace `-` by `_`
- Add a leading `_` if the package name starts with a digit

To go from Python module name to Spack package name:
- Strip leading `_`
- Replace `_` by `-`.
2025-05-05 10:52:16 +02:00
..
_gh_pages_redirect
_pygments Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
_static
_templates docs: re-enable google analytics (#43974) 2024-05-02 21:56:19 -04:00
build_systems Add type hints to all setup_*environment functions (#49985) 2025-04-23 15:41:22 +02:00
images Update release documentation (#46991) 2024-10-16 09:11:53 +02:00
tables build caches: collect files to relocate while tarballing w/o file (#48212) 2024-12-24 10:53:13 -07:00
.gitignore
basic_usage.rst Concrete multi-valued variants (#49756) 2025-04-04 04:47:43 +00:00
binary_caches.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
bootstrapping.rst Fix creating a bootstrap mirrors (#48252) 2025-01-27 22:37:29 +00:00
build_settings.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
build_systems.rst Update documentation after compiler as deps (#49715) 2025-03-27 11:19:35 +01:00
chain.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
command_index.in
conf.py lang.py: make HashableMap generic, and use in Spec (#50229) 2025-05-05 10:45:11 +02:00
config_yaml.rst config:url_fetch_method: allow curl args (#49712) 2025-04-01 15:23:28 -05:00
configuration.rst docs: editor support config files (#49935) 2025-04-07 15:35:21 +02:00
containers.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
contribution_guide.rst Remove pipelines and images based on ppc64le (#48767) 2025-01-29 16:36:25 +01:00
developer_guide.rst package API v2.0: new repo layout (#49256) 2025-05-05 10:52:16 +02:00
env_vars_yaml.rst Env vars docs (#49346) 2025-04-21 18:59:01 -06:00
environments.rst Env vars docs (#49346) 2025-04-21 18:59:01 -06:00
extensions.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
features.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
frequently_asked_questions.rst docs: add strong preferences to faq (#49556) 2025-03-19 08:53:14 +01:00
getting_started.rst Update documentation after compiler as deps (#49715) 2025-03-27 11:19:35 +01:00
gpu_configuration.rst docs: remove leftover references to compiler: entries (#49824) 2025-04-02 09:33:23 +02:00
include_yaml.rst Documentation: remote URL inclusion updates (#49669) 2025-04-01 09:02:50 +02:00
index.rst Env vars docs (#49346) 2025-04-21 18:59:01 -06:00
Makefile
mirrors.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
module_file_generation.svg
module_file_support.rst Add type hints to all setup_*environment functions (#49985) 2025-04-23 15:41:22 +02:00
packages_yaml.rst docs: remove leftover references to compiler: entries (#49824) 2025-04-02 09:33:23 +02:00
packaging_guide.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
pipelines.rst Turn compilers into nodes (#45189) 2025-03-25 22:32:49 -06:00
replace_conda_homebrew.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
repositories.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
requirements.txt build(deps): bump urllib3 from 2.3.0 to 2.4.0 in /lib/spack/docs (#50014) 2025-04-14 10:07:24 +02:00
signing.rst Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00
spack.yaml Remove years from license headers (#48352) 2025-01-02 15:40:28 +01:00