Usage: forc-doc [OPTIONS]
Options:
--manifest-path <MANIFEST_PATH>
Path to the Forc.toml file. By default, forc-doc searches for the Forc.toml file in the current directory or any parent directory
--document-private-items
Include non-public items in the documentation
--open
Open the docs in a browser after building them
--offline
Offline mode, prevents Forc from using the network when managing dependencies. Meaning it will only try to use previously downloaded dependencies
-s, --silent
Silent mode. Don't output any warnings or errors to the command line
--locked
Requires that the Forc.lock file is up-to-date. If the lock file is missing, or it needs to be updated, Forc will exit with an error
--no-deps
Do not build documentation for dependencies
--ipfs-node <IPFS_NODE>
The IPFS Node to use for fetching IPFS sources.
Possible values: PUBLIC, LOCAL, <GATEWAY_URL>
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
EXAMPLES: #Build the docs for a project in the current path forc doc
#Build the docs for a project in the current path and open it in the browser forc doc --open
#Build the docs for a project located in another path forc doc --manifest-path ../tests_project2
#Build the docs for the current project exporting private types forc doc --document-private-items
#Build the docs offline without downloading any dependency from the network forc doc --offline