PacletTools`
PacletTools`

PacletBuild

PacletBuild[source]

builds the paclet located at source.

PacletBuild[source, builddir]

builds the paclet located at source into builddir.

Details and Options

  • source must be a file path to a paclet directory in the local file system, or a PacletObject.
  • Paclet documentation authored with DocumentationTools will be built into styled notebooks.
  • The default build directory is "source/build".
  • PacletBuild[source] may delete all existing files in the "source/build/name" directory, where name is the value of the "Name" field of the specified paclet.
  • PacletBuild[source, builddir] may delete all existing files in the "builddir/name" directory. Do not specify a builddir location that contains original copies of files that should not be deleted.
  • PacletBuild has the following options:
  • "SystemID"AllSystemID used to filter extensions
    LanguageAllLanguage used to filter extensions
  • Only files described by the "Extensions" field of the PacletInfo.wl file will be included in the built paclet. Common paclet extension types include:
  • "Kernel"All files in source/Kernel/
    "Documentation"All .nb files in source/Documentation/
    "Asset"All files named in the extension
  • PacletBuild uses PacletExtensionFiles to determine the set of files to include in the built paclet.
  • PacletBuild uses CreatePacletArchive to generate the final .paclet file.
  • PacletBuild performs incremental documentation builds. After an initial build that processes each documentation notebook, subsequent calls to PacletBuild will only re-process documentation files that have been added or modified since the previous build. If the build output directory is deleted, all documentation files will need to be re-processed during the next build.

Examples

open allclose all

Basic Examples  (2)

Begin by ensuring PacletTools` is loaded:

Build a paclet source directory into a distributable .paclet file:

Possible Issues  (1)

PacletBuild will return an error if builddir is the paclet source directory:

Wolfram Research (2020), PacletBuild, Wolfram Language function, https://reference.wolfram.com/language/PacletTools/ref/PacletBuild.html (updated 2021).

Text

Wolfram Research (2020), PacletBuild, Wolfram Language function, https://reference.wolfram.com/language/PacletTools/ref/PacletBuild.html (updated 2021).

CMS

Wolfram Language. 2020. "PacletBuild." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2021. https://reference.wolfram.com/language/PacletTools/ref/PacletBuild.html.

APA

Wolfram Language. (2020). PacletBuild. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/PacletTools/ref/PacletBuild.html

BibTeX

@misc{reference.wolfram_2024_pacletbuild, author="Wolfram Research", title="{PacletBuild}", year="2021", howpublished="\url{https://reference.wolfram.com/language/PacletTools/ref/PacletBuild.html}", note=[Accessed: 22-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_pacletbuild, organization={Wolfram Research}, title={PacletBuild}, year={2021}, url={https://reference.wolfram.com/language/PacletTools/ref/PacletBuild.html}, note=[Accessed: 22-November-2024 ]}