Specification rendering tools#367
Open
athoelke wants to merge 3 commits into
Open
Conversation
athoelke
added
enhancement
Signed-off-by: Andrew Thoelke <andrew.thoelke@arm.com>
Signed-off-by: Andrew Thoelke <andrew.thoelke@arm.com>
Signed-off-by: Andrew Thoelke <andrew.thoelke@arm.com>
athoelke
force-pushed
the
introduce-psa-api-tool
branch
from
b2e80ed to
b1c5a3b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This an open source version of the scripts and Sphinx extension that are used to convert the specification sources into the HTML and PDF publications.
Included in the tools are two two templates (psa-api-2022 and psa-api-2025) used by the tagged and released commits for published revisions of these specifications.
Instructions for setting up the tools and running them are included (and sign-posted from README). Also included is a full guide to the extensions roles and directives used by the specs, and the document configuration model.
The tool scripts and documentation are all licensed under Apache 2.0, and the text and graphic content of the templates is CC-BY-SA 4.0 as per the specification sources.
The tooling and integration into the build system easily permits the use of an external copy (or fork) of the tools directory via the command-line or environment, without needing to modify the specification sources or configuration.