Skip to content

Don't Build Docs by Default! #2095

@citibeth

Description

@citibeth

In general... Spack packages should not build documentation unless asked to do so (eg. with a +docs variant). Reasons:

  1. Building docs can involve large/annoying dependencies (doxygen, latex, etc.)
  2. Users don't usually want docs except for packages near the top of the DAG for a particular user's needs. CGAL might be a great and clever system; but people installing stuff five levels up just don't care.
  3. Even if a packages is close to the top, users often just rely on on-line docs anyway.

I'm guilty of not following this advice (need to fix for glint2 and icebin packages).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions