documento

Documenta un paquete de mudanza

Esto convierte el contenido del paquete en rebajas para documentación.

Uso

movement aptos move document [OPTIONS]

Opciones

• --dev Habilita el modo de desarrollo, que utiliza todas las direcciones y dependencias de desarrollo. El modo de desarrollo permite cambiar dependencias y direcciones a los campos preestablecidos [direcciones de desarrollo] y [dependencias de desarrollo]. Esto funciona tanto dentro como fuera de las pruebas para usar valores preestablecidos. Actualmente, también incorpora todos los artefactos de compilación de prueba.

• --package-dir <PACKAGE_DIR> Ruta a un paquete de movimiento (la carpeta con un archivo Move.toml).

• --output-dir <OUTPUT_DIR> Ruta para guardar el paquete de movimiento compilado. El valor predeterminado es <package_dir>/build.

• --named-addresses <NAMED_ADDRESSES> Direcciones con nombre para el binario de movimiento. Ejemplo: alicia=0x1234, bob=0x5678. Nota: Esto fallará si hay duplicados en el archivo Move.toml, elimínelos primero. [por defecto: ]

• --skip-fetch-latest-git-deps Evite extraer las últimas dependencias de git. Esto permitirá anular esto para el desarrollo local.

• --bytecode-version <BYTECODE_VERSION> Especifique la versión del código de bytes que emitirá el compilador.

• --include-impl Si se deben incluir declaraciones e implementaciones privadas en la documentación generada. El valor predeterminado es falso.

• --include-specs Si incluir especificaciones en la documentación generada. El valor predeterminado es falso.

• --specs-inlined Si las especificaciones deben colocarse al lado de las declaraciones o en una sección separada. El valor predeterminado es falso.

• --include-dep-diagram Si se debe incluir un diagrama de dependencia. El valor predeterminado es falso.

• --collapsed-sections Si los detalles deben colocarse en secciones contraídas. Esto no es compatible con todas las rebajas, sino con el dialecto de github. El valor predeterminado es falso.

• --landing-page-template <LANDING_PAGE_TEMPLATE> Ruta relativa al paquete a una plantilla de rebajas opcional que se utiliza para crear una página de destino. Los marcadores de posición en este archivo se sustituyen de la siguiente manera: > {{move-toc}}se reemplaza por una tabla de contenido de todos los módulos; > {{move-index}}se reemplaza por un índice y > {{move-include NAME_OF_MODULE_OR_SCRIP}}se reemplaza por la documentación completa de la entidad nombrada.

• --references-file <REFERENCES_FILE> Ruta relativa al paquete a un archivo cuyo contenido se agrega a cada archivo de rebajas generado. Esto puede contener referencias de rebajas comunes para este paquete (p. ej. [move-book]: <url>).