Tareas comunes

Estas son pequeñas guías de cómo hacer para algunas tareas comunes, sin ningún orden en particular:

Actualizar las tablas de propiedades

La red y node Las páginas contienen fragmentos HTML estáticos generados automáticamente a partir del código fuente de BitxorCore y los archivos de configuración de Bootstrap. El código de generación está en el repositorio bitxorcore-docs-cli y necesitará usar las ``propiedades `` comando.

El archivo README ya contiene una sección sobre cómo generar estas tablas.

Siempre que cambie uno de los valores de propiedad predeterminados, deberá actualizar las tablas y confirmar los archivos HTML resultantes en el repositorio bitxor-docs.

Actualizar las tablas de serialización

Las tablas serialization también se generan automáticamente utilizando bitxorcore-docs-cli repositorio, usando el comando serialization.

El archivo README ya contiene una sección sobre cómo generar estas tablas.

El comando serialización generará un archivo HTML independiente para cada estructura y un solo archivo .rst o .md que incluye todos ellos para usar como página de serialización en los documentos. El comando ya coloca los archivos en su lugar adecuado en la carpeta bitxor-docs.

Los archivos HTML individuales se pueden incluir en cualquier página de documentos usando la directiva .. serializationref::.

Redirecciones

Cada vez que cambie el nombre o elimine una página de documento existente, es probable que esté rompiendo el enlace de alguien a los documentos. Para evitar esto, deja un Redireccionamiento en su lugar.

El archivo redirects en la carpeta source contiene una lista de pares “viejo-nombre nuevo-nombre�?, separados por un espacio. En el proceso de compilación, Sphinx creará archivos HTML para todos los “nombres antiguos�?que contengan una redirección al “nombre nuevo�?