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
- paclet must be a file path to a paclet directory in the local file system, or a PacletObject.
- To be used with PacletDocumentationBuild, paclet must declare at least one "Documentation" extension.
- Paclet documentation authored with DocumentationTools will be built into styled notebooks.
- PacletDocumentationBuild performs incremental rebuilds. Only documentation notebooks that have changed since the last call to PacletDocumentationBuild will be built again.
- PacletDocumentationBuild[paclet, CloudObject[…]] builds notebook documentation and then deploys those notebooks to the cloud.
- PacletDocumentationBuild[paclet, CloudObject[…], "HTML"] builds HTML documentation and then deploys those HTML files and associated assets to the cloud.
- PacletDocumentationBuild[paclet, builddir] is equivalent to PacletDocumentationBuild[paclet, builddir, "Notebooks"]
- PacletDocumentationBuild has the following options:
-
OverwriteTarget False whether to overwrite files when building to a CloudObject[..] destination - If builddir is a CloudObject and the "HTML" format is specified, a "Pages" key containing the URLs of the uploaded documentation pages (and excluding the CSS and JavaScript assets) will be included in the Success object returned by PacletDocumentationBuild.
Examples
open allclose allBasic 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)
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:
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