Skip to content

Commit 2ecc12d

Browse files
aforsytheaforsythe
committed
add amf implementation guide and mkdocs system
1 parent eaf8122 commit 2ecc12d

File tree

16 files changed

+1470
-0
lines changed

16 files changed

+1470
-0
lines changed

‎.github/workflows/main.yml

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Build Mkdocs Site
2+
on:
3+
push:
4+
branches:
5+
- dev
6+
- main
7+
jobs:
8+
docker:
9+
name: Build Mkdocs site from docker container
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout dev branch
13+
if: endsWith(github.ref, '/dev')
14+
uses: actions/checkout@v2
15+
with:
16+
ref: dev
17+
fetch-depth: 0
18+
- name: Checkout main branch
19+
if: endsWith(github.ref, '/main')
20+
uses: actions/checkout@v2
21+
with:
22+
ref: main
23+
fetch-depth: 0
24+
- name: Setup git config
25+
run: |
26+
git config user.name "GitHub Actions Bot"
27+
git config user.email "<>"
28+
- name: Build docker image
29+
uses: docker/build-push-action@v2
30+
with:
31+
context: .
32+
push: false
33+
tags: app:latest
34+
- name: Run mkdocs build via docker
35+
uses: addnab/docker-run-action@v3
36+
with:
37+
image: app:latest
38+
options: --rm -v ${{ github.workspace }}:/docs -v ${{ github.workspace }}/site:/site
39+
run: mkdocs build;
40+
- name: Commit dev updates to site/staging branch
41+
if: endsWith(github.ref, '/dev')
42+
run: |
43+
sudo chown -R runner:docker site;
44+
git stash -u;
45+
git fetch;
46+
git switch site/staging;
47+
rm -rf site;
48+
git clean -d -x -f;
49+
git stash pop;
50+
git add .;
51+
git commit -m 'Gitbot actions site change';
52+
git push origin;
53+
- name: Commit main updates to site branch
54+
if: endsWith(github.ref, '/main')
55+
run: |
56+
sudo chown -R runner:docker site;
57+
git stash -u;
58+
git fetch;
59+
git switch site/production;
60+
rm -rf site;
61+
git clean -d -x -f;
62+
git stash pop;
63+
git add .;
64+
git commit -m 'Gitbot actions site change';
65+
git push origin;
66+

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.vscode

‎Dockerfile

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
FROM squidfunk/mkdocs-material
2+
3+
WORKDIR /tmp
4+
COPY requirements.txt requirements.txt
5+
RUN pip install -r requirements.txt
6+
WORKDIR /docs

‎mkdocs.yml

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
site_name: ACES Technical Documentation
2+
copyright: Copyright &copy; 2022 Academy of Motion Picture Arts & Sciences
3+
4+
repo_url: https://github.com/ampas/aces-dev
5+
repo_name: aces-dev
6+
edit_uri: https://github.com/aforsythe/aces-docs/edit/amf-userguide/mkdocs/docs
7+
8+
site_dir: /site
9+
docs_dir: mkdocs/docs
10+
11+
extra:
12+
generator: false
13+
14+
extra_css:
15+
- stylesheets/extra.css
16+
17+
theme:
18+
name: 'material'
19+
custom_dir: mkdocs/overrides
20+
features:
21+
- navigation.tabs
22+
# - navigation.indexes
23+
- navigation.tracking
24+
- navigation.expand
25+
- navigation.top
26+
- navigation.instant
27+
favicon: assets/images/favicon.png
28+
logo: assets/images/logo.png
29+
font:
30+
text: Pontano Sans
31+
icon:
32+
repo: fontawesome/brands/github
33+
palette:
34+
- media: "(prefers-color-scheme: light)"
35+
scheme: aces-light
36+
toggle:
37+
icon: material/toggle-switch-off-outline
38+
name: Switch to dark mode
39+
- media: "(prefers-color-scheme: dark)"
40+
scheme: slate
41+
toggle:
42+
icon: material/toggle-switch
43+
name: Switch to light mode
44+
45+
markdown_extensions:
46+
- pymdownx.arithmatex:
47+
generic: true
48+
- pymdownx.superfences:
49+
custom_fences:
50+
- name: mermaid
51+
class: mermaid
52+
format: !!python/name:mermaid2.fence_mermaid
53+
- pymdownx.emoji:
54+
emoji_index: !!python/name:materialx.emoji.twemoji
55+
emoji_generator: !!python/name:materialx.emoji.to_svg
56+
- pymdownx.snippets
57+
- pymdownx.magiclink
58+
- attr_list
59+
- md_in_html
60+
- abbr
61+
- def_list
62+
- toc:
63+
permalink: true
64+
toc_depth: 3
65+
66+
extra_javascript:
67+
- https://polyfill.io/v3/polyfill.min.js?features=es6
68+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
69+
- https://unpkg.com/[email protected]/dist/mermaid.min.js
70+
- extra/refresh_on_toggle_dark_light.js
71+
72+
plugins:
73+
- search
74+
- mermaid2:
75+
version: 8.8.4
76+
arguments:
77+
securityLevel: 'loose'
78+
themeVariables:
79+
primaryColor: '#ff0000'
80+
theme: |
81+
^(JSON.parse(__md_get("__palette").index == 1)) ? 'dark' : 'light'
82+
- git-revision-date-localized:
83+
type: date
84+
locale: en
85+
86+
nav:
87+
- 'ACES Documentation':
88+
- 'Implementation Guides':
89+
- 'ACES Metadata File (AMF)': guides/amf/index.md
90+
- 'Glossary': glossary/index.md

‎mkdocs/docs/assets/images/favicon.png

2.62 KB
Loading

‎mkdocs/docs/assets/images/logo.png

13.7 KB
Loading

‎mkdocs/docs/extra/refresh_on_toggle_dark_light.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
var paletteSwitcher1 = document.getElementById("__palette_1");
2+
var paletteSwitcher2 = document.getElementById("__palette_2");
3+
4+
paletteSwitcher1.addEventListener("change", function () {
5+
location.reload();
6+
});
7+
8+
paletteSwitcher2.addEventListener("change", function () {
9+
location.reload();
10+
});

‎mkdocs/docs/glossary/index.md

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Terms and Definitions
2+
3+
## A
4+
Academy Color Encoding Specification (ACES)
5+
: RGB color encoding for exchange of image data that have not been color rendered, between and throughout production and postproduction, within the Academy Color Encoding System. ACES is specified in SMPTE ST 2065-1.
6+
7+
ACES RGB relative exposure values
8+
: Relative responses to light of the ACES Reference Image Capture Device, determined by the integrated spectral responsivities of its color channels and the spectral radiances of scene stimuli.
9+
10+
ACES unity neutral
11+
: A triplet of ACES RGB relative exposure values all of which have unity magnitude.
12+
13+
14+
ACES Metadata File (AMF)
15+
: Metadata “sidecar” XML-based file that contains information describing a collection of image files color-managed using the Academy Color Encoding System (ACES).
16+
17+
ACES Encodings
18+
: Color encoding specifications specified as part of the Academy Color Encoding System, e.g., ACES2065-1, ACEScc, etc.
19+
20+
ACES File Formats
21+
: Digital data containers specified as part of the Academy Color Encoding System, e.g., ACES Metadata Files, ACES Image Container (SMPTE ST2065-4), etc.
22+
23+
ACES Product Partners
24+
: Companies that integrate ACES concepts and components into their products and/or services.
25+
26+
ACES System
27+
: Complete set of components that comprise the Academy Color Encoding System.
28+
29+
ACES System Release
30+
: Published ACES System.
31+
32+
ACES Transforms
33+
: Color transformations specified as part of the Academy Color Encoding System, e.g., Reference Rendering Transform (RRT), Output Device Transforms (ODT), etc.
34+
35+
ACES Viewing Transform
36+
: Combined RRT and ACES Output Device Transform.
37+
38+
## B
39+
40+
## C
41+
chromatic adaptation
42+
: process by which the visual mechanism adjusts in response to the radiant energy to which the eyes are exposed.
43+
44+
chromaticity
45+
: property of a color stimulus defined by the ratios of each tristimulus value of the color stimulus to their sum.
46+
47+
Color Transform Langage (CTL)
48+
: small open-source programming language, consisting of an interpreter and one or more CLT modules, that has been designed to serve as a building block for digital color management systems.
49+
50+
CTL modules (files)
51+
: files containing Color Transformation Language code.
52+
: Note: CTL files are the primary documentation for ACES transforms.
53+
54+
## D
55+
DateTime
56+
: (reference: [ISO 8601:2004](https://www.iso.org/standard/40874.html)) timestamp format
57+
: The DateTime is specified in the following form `YYYY-MM-DDThh:mm:ss{offset}` where:
58+
: * `YYYY` indicates the year
59+
: * `MM` indicates the month
60+
: * `DD` indicates the day
61+
: * `T` indicates the start of the required time section
62+
: * `hh` indicates the hour
63+
: * `mm` indicates the minute
64+
: * `ss` indicates the second
65+
: * `{offset}` time zone offset from UTC
66+
: NOTE: All components are required.
67+
: Example: `2014-11-20T12:24:13-8:00`
68+
69+
## E
70+
Edit Decision List (EDL)
71+
: list used in the post-production process of film editing and video editing containing an ordered sequence of reel and timecode data representing where each video clip can be obtained in order to conform to the final cut.
72+
73+
Extensible Markup Language (XML)
74+
: a markup language and file format for storing, transmitting, and reconstructing arbitrary data. It defines a set of rules for encoding documents in a format that is both human-readable and machine-readable
75+
76+
## F
77+
78+
## G
79+
80+
## H
81+
82+
## I
83+
Implementation Transforms
84+
: ACES System transforms implemented by ACES Product Partners, likely as a Color Look-up Table or as GPU or CPU code.
85+
86+
Internet Engineering Task Force (IETF)
87+
: an open standards organization, which develops and promotes voluntary Internet standards, in particular the technical standards that comprise the Internet protocol suite (TCP/IP).
88+
89+
## J
90+
91+
## K
92+
93+
## L
94+
## M
95+
## N
96+
## O
97+
## P
98+
## Q
99+
## R
100+
Reference Rendering Transform(RRT)
101+
: Core ACES transform that converts scene-referred image data that conforms to SMPTE ST 2065-1:2012 to output-referred image data.
102+
103+
RFN
104+
: technical specification or organizational note published by the Internet Engineering Task Force (IETF)
105+
106+
## S
107+
## T
108+
Transform Identifiers
109+
: string identifying the ACES transform.
110+
: Note:
111+
: Please see the ACES System Versioning Specification for more information on the format to use for TransformIDs.
112+
113+
## U
114+
Universal(ly) Unique Identifier (UUID)
115+
: 128-bit label used for information in computer systems published in various standards including ISO/IEC 11578:1996 "Information technology – Open Systems Interconnection – Remote Procedure Call (RPC)"
116+
117+
## V
118+
## W
119+
## X
120+
## Y
121+
## Z
122+
123+
124+
125+
--8<-- "mkdocs/includes/acronyms.md"

0 commit comments

Comments
 (0)