Skip to content

Commit 00698a9

Browse files
author
Andrean Franc
committed
Initial documentation import
Signed-off-by: Andrean Franc <andrean.franc@epicgames.com>
1 parent 7bd4c65 commit 00698a9

88 files changed

Lines changed: 9370 additions & 3 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/_config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
title: OpenRigLogic
2+
theme: jekyll-theme-cayman
3+
exclude:
4+
- design
5+
defaults:
6+
- scope:
7+
path: ""
8+
values:
9+
render_with_liquid: false

docs/design/design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
RigLogic 4
2-
==========
1+
OpenRigLogic
2+
============
33

44
Overview
55
--------

docs/design/src.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# RigLogic 4
1+
# OpenRigLogic
22

33
## Overview
44

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: default
3+
redirect_to: wiki/
4+
---
5+
<meta http-equiv="refresh" content="0; url=wiki/">

docs/mkdocs.yml

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
site_name: OpenRigLogic
2+
site_url: https://epicgames.github.io/OpenRigLogic/
3+
docs_dir: wiki
4+
theme:
5+
name: readthedocs
6+
7+
exclude_docs: _Sidebar.md
8+
9+
nav:
10+
- Home: index.md
11+
- Release Notes: release_notes.md
12+
- API Reference:
13+
- Overview: api/index.md
14+
- arrayview:
15+
- Overview: api/arrayview/index.md
16+
- ArrayView: api/arrayview/ArrayView.md
17+
- StringView: api/arrayview/StringView.md
18+
- dna:
19+
- Overview: api/dna/index.md
20+
- BinaryStreamReader: api/dna/BinaryStreamReader.md
21+
- BinaryStreamWriter: api/dna/BinaryStreamWriter.md
22+
- Configuration: api/dna/Configuration.md
23+
- JSONStreamReader: api/dna/JSONStreamReader.md
24+
- JSONStreamWriter: api/dna/JSONStreamWriter.md
25+
- Reader: api/dna/Reader.md
26+
- StreamReader: api/dna/StreamReader.md
27+
- StreamWriter: api/dna/StreamWriter.md
28+
- Writer: api/dna/Writer.md
29+
- layers:
30+
- BehaviorReader: api/dna/layers/BehaviorReader.md
31+
- BehaviorWriter: api/dna/layers/BehaviorWriter.md
32+
- DefinitionReader: api/dna/layers/DefinitionReader.md
33+
- DefinitionWriter: api/dna/layers/DefinitionWriter.md
34+
- Descriptor: api/dna/layers/Descriptor.md
35+
- DescriptorReader: api/dna/layers/DescriptorReader.md
36+
- DescriptorWriter: api/dna/layers/DescriptorWriter.md
37+
- Geometry: api/dna/layers/Geometry.md
38+
- GeometryReader: api/dna/layers/GeometryReader.md
39+
- GeometryWriter: api/dna/layers/GeometryWriter.md
40+
- HeaderReader: api/dna/layers/HeaderReader.md
41+
- HeaderWriter: api/dna/layers/HeaderWriter.md
42+
- JointBehaviorMetadata: api/dna/layers/JointBehaviorMetadata.md
43+
- JointBehaviorMetadataReader: api/dna/layers/JointBehaviorMetadataReader.md
44+
- JointBehaviorMetadataWriter: api/dna/layers/JointBehaviorMetadataWriter.md
45+
- MachineLearnedBehavior: api/dna/layers/MachineLearnedBehavior.md
46+
- MachineLearnedBehaviorExt: api/dna/layers/MachineLearnedBehaviorExt.md
47+
- MachineLearnedBehaviorExtReader: api/dna/layers/MachineLearnedBehaviorExtReader.md
48+
- MachineLearnedBehaviorExtWriter: api/dna/layers/MachineLearnedBehaviorExtWriter.md
49+
- MachineLearnedBehaviorReader: api/dna/layers/MachineLearnedBehaviorReader.md
50+
- MachineLearnedBehaviorWriter: api/dna/layers/MachineLearnedBehaviorWriter.md
51+
- RBFBehavior: api/dna/layers/RBFBehavior.md
52+
- RBFBehaviorReader: api/dna/layers/RBFBehaviorReader.md
53+
- RBFBehaviorWriter: api/dna/layers/RBFBehaviorWriter.md
54+
- Twist: api/dna/layers/Twist.md
55+
- TwistSwingBehaviorReader: api/dna/layers/TwistSwingBehaviorReader.md
56+
- TwistSwingBehaviorWriter: api/dna/layers/TwistSwingBehaviorWriter.md
57+
- types:
58+
- Vector3: api/dna/types/Vector3.md
59+
- version:
60+
- VersionInfo: api/dna/version/VersionInfo.md
61+
- pma:
62+
- Overview: api/pma/index.md
63+
- MemoryResource: api/pma/MemoryResource.md
64+
- PolyAllocator: api/pma/PolyAllocator.md
65+
- ScopedPtr: api/pma/ScopedPtr.md
66+
- TypeDefs: api/pma/TypeDefs.md
67+
- resources:
68+
- AlignedMemoryResource: api/pma/resources/AlignedMemoryResource.md
69+
- ArenaMemoryResource: api/pma/resources/ArenaMemoryResource.md
70+
- DefaultMemoryResource: api/pma/resources/DefaultMemoryResource.md
71+
- utils:
72+
- ManagedInstance: api/pma/utils/ManagedInstance.md
73+
- riglogic:
74+
- Overview: api/riglogic/index.md
75+
- Configuration: api/riglogic/riglogic/Configuration.md
76+
- RigInstance: api/riglogic/riglogic/RigInstance.md
77+
- RigLogic: api/riglogic/riglogic/RigLogic.md
78+
- Stats: api/riglogic/riglogic/Stats.md
79+
- types:
80+
- Aliases: api/riglogic/types/Aliases.md
81+
- version:
82+
- VersionInfo: api/riglogic/version/VersionInfo.md
83+
- status:
84+
- Overview: api/status/index.md
85+
- Provider: api/status/Provider.md
86+
- Status: api/status/Status.md
87+
- StatusCode: api/status/StatusCode.md
88+
- tdm:
89+
- Overview: api/tdm/index.md
90+
- Ang: api/tdm/Ang.md
91+
- Computations: api/tdm/Computations.md
92+
- CoordSys: api/tdm/CoordSys.md
93+
- Mat: api/tdm/Mat.md
94+
- Quat: api/tdm/Quat.md
95+
- Transforms: api/tdm/Transforms.md
96+
- Types: api/tdm/Types.md
97+
- Vec: api/tdm/Vec.md
98+
- trio:
99+
- Overview: api/trio/index.md
100+
- Concepts: api/trio/Concepts.md
101+
- Stream: api/trio/Stream.md
102+
- streams:
103+
- FileStream: api/trio/streams/FileStream.md
104+
- MemoryMappedFileStream: api/trio/streams/MemoryMappedFileStream.md
105+
- MemoryStream: api/trio/streams/MemoryStream.md
106+
- types:
107+
- Parameters: api/trio/types/Parameters.md
108+
- utils:
109+
- StreamScope: api/trio/utils/StreamScope.md

docs/wiki/_Sidebar.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
### [OpenRigLogic](Home)
2+
3+
A C++ runtime that evaluates character rig control logic via a DNA data format.
4+
5+
---
6+
7+
### [API Reference](api-index)
8+
9+
- [arrayview](api-arrayview-index)
10+
- [dna](api-dna-index)
11+
- [pma](api-pma-index)
12+
- [riglogic](api-riglogic-index)
13+
- [status](api-status-index)
14+
- [tdm](api-tdm-index)
15+
- [trio](api-trio-index)
16+
17+
---
18+
19+
### [Release Notes](release_notes)
20+

0 commit comments

Comments
 (0)