summaryrefslogtreecommitdiff
path: root/doc/doc.mk
AgeCommit message (Collapse)Author
2024-01-30doc: Add version information to PDF title pagexengineering
Since otherwise the Git describe output / version information is only embedded into the file name the risk is given that Git version information is lost by renaming the file.
2024-01-27doc: Use Git-provided commit date for PDFxengineering
Using the date of the build makes it not-reproducible. This should be avoided. Furthermore the date on the front page should anyway reflect when the source of the document was created. Not when it was converted into a PDF.
2024-01-05doc: Write section 'Versioning'xengineering
This section is important to communicate how to interpret version numbers in the context of this device repository.
2024-01-05doc: Build twice with LaTeXxengineering
This is required to build the table of contents and similar parts of the document correctly.
2024-01-05doc: Remove 'soundbox-' prefix from doc PDFxengineering
Inside the artifacts folder aswell as inside the source folder adding a 'soundbox-' prefix to files is uncommon. In both cases only the root level folder should contain the name 'soundbox' to remove redundancies.
2024-01-03doc: Add automated PDF generationxengineering
The build system should convert the documentation source files automatically to a single PDF file to make documentation generation trivial.