PacletTools`
PacletTools`

PacletDocumentationBuild

PacletDocumentationBuild[paclet]

builds documentation for paclet.

PacletDocumentationBuild[paclet, builddir]

builds documentation for paclet into builddir.

PacletDocumentationBuild[paclet,CloudObject[]]

builds documentation for paclet and deploy it to the specified cloud directory.

PacletDocumentationBuild[paclet, builddir, "HTML"]

builds HTML documentation for paclet into builddir.

PacletDocumentationBuild[paclet, CloudObject[], "HTML"]

builds HTML documentation for paclet and deploy it to the specified cloud directory.

Details and Options

Examples

open allclose all

Basic Examples  (4)

Begin by ensuring PacletTools` is loaded:

Build documentation for a paclet:

View a built documentation notebook:

View the unbuilt source documentation notebook:

Build HTML documentation and deploy it to the cloud:

Open one of the built pages in your web browser:

Build public HTML documentation to the cloud by specifying Permissions "Public":

Documentation deployed in this way will be visible to everyone, even visitors without a Wolfram Cloud account.

Scope  (1)

Build notebook documentation and deploy it to the cloud:

View the built documentation in your web browser:

Options  (1)

OverwriteTarget  (1)

When deploying to a remote CloudObject destination, PacletDocumentationBuild will not overwrite existing files by default:

Use OverwriteTarget -> True to overwrite existing files:

Note that OverwriteTarget -> True will not delete files that were previously deployed, even if they are no longer present in the source documentation. Use DeleteObject to completely clear deployed documentation:

Properties & Relations  (1)

CloudObject permissions may be changed after a build by accessing the "CloudObjects" field of the build result:

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

Text

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

CMS

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

APA

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

BibTeX

@misc{reference.wolfram_2022_pacletdocumentationbuild, author="Wolfram Research", title="{PacletDocumentationBuild}", year="2021", howpublished="\url{https://reference.wolfram.com/language/PacletTools/ref/PacletDocumentationBuild.html}", note=[Accessed: 06-July-2022 ]}

BibLaTeX

@online{reference.wolfram_2022_pacletdocumentationbuild, organization={Wolfram Research}, title={PacletDocumentationBuild}, year={2021}, url={https://reference.wolfram.com/language/PacletTools/ref/PacletDocumentationBuild.html}, note=[Accessed: 06-July-2022 ]}