-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.html
157 lines (147 loc) · 8.71 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Flax Engine Documentation | Flax Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Flax Engine Documentation | Flax Documentation ">
<meta name="generator" content="docfx 2.58.9.0">
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="">
<meta property="docfx:newtab" content="true">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@flaxengine">
<meta name="og:title" content="Flax Engine Documentation | Flax Documentation ">
<meta property="og:image" content="https://docs.flaxengine.com/media/social-image.jpg">
<script async="" src="https://www.googletagmanager.com/gtag/js?id=UA-88357703-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-88357703-2');
</script>
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="https://www.flaxengine.com">
<div style="text-align:center; line-height:45px">
<img id="logo" height="40" width="40" src="logo.png" alt="">
</div>
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="flax-engine-documentation">Flax Engine Documentation</h1>
<p><img src="manual/graphics/post-effects/media/postFx.png" alt="Flax Engine Docs"></p>
<p>Welcome to the Flax documentation repository. This repository contains all the source files for the Flax documentation (<a href="https://docs.flaxengine.com/">https://docs.flaxengine.com/</a>). Anyone is welcome to contribute!</p>
<h2 id="editing">Editing</h2>
<p>We use <a href="https://github.com/dotnet/docfx">DocFX</a> tool for building and hosting documentation online. It supports markdown style files (<code>.md</code>) as it's a very standardized and popular format. Writing technical documentation using markdown style is easy and efficient.</p>
<p>To edit docs we recommend you to use tools such as <a href="https://www.zettlr.com/">Zettlr</a> or <a href="https://typora.io/">Typora</a> or <a href="https://code.visualstudio.com/">Visual Studio Code</a>.</p>
<h2 id="building-and-testing">Building and Testing</h2>
<p>Documentation can be built and hosted on both Linux and Windows. DocFx can run on .Net or Mono. By default the site is hosted on <code>localhost:8080</code> but this can be easily configured.</p>
<h3 id="windows">Windows</h3>
<ul>
<li>Download repository (or clone with <code>git clone https://github.com/FlaxEngine/FlaxDocs.git</code>)</li>
<li>Call <code>build_manual.bat</code> to build the Manual or <code>build_all.bat</code> to build whole documentation (with API) but it will take more time to finish</li>
<li>Call <code>run_local_website.bat</code> to preview the site</li>
</ul>
<h3 id="linux">Linux</h3>
<ul>
<li>Install <a href="http://www.mono-project.com/docs/getting-started/install/linux/">Mono</a></li>
<li>Clone repository (<code>git clone https://github.com/FlaxEngine/FlaxDocs.git</code>)</li>
<li>Call <code>chmod +x docs.sh</code>. It will modify permissions for the script <code>docs.sh</code> to allow to execute it</li>
<li>Call <code>./docs.sh rebuild</code></li>
</ul>
<h2 id="technical-notes">Technical Notes</h2>
<p>C# and C++ API reference pages are generated by downloading and building engine at a given revision specified in file <code>commit.txt</code>. C# API is extracted via <code>docfx metadata</code> into <code>api</code> folder. C++ API is extracted via our custom fork of <a href="https://github.com/FlaxEngine/code2yaml">code2yaml</a> which parses engine header files with <code>doxygen</code> to generate metadata into <code>api-cpp</code> folder.</p>
<p>Key configuration files:</p>
<ul>
<li><code>docfx.json</code> - config for docfx documentation building.</li>
<li><code>code2yaml.json</code> - config for code2yaml used to extract api docs for C++.</li>
<li><code>doxyfile</code> - config for doxygen to output xml files with engine api to be processed by code2yaml.</li>
<li><code>commit.txt</code> - contains commit hash of the <a href="https://github.com/FlaxEngine/FlaxEngine">FlaxEngine</a> revision to use for the API building.</li>
<li><code>.github\workflows\docs-publish.yml</code> - Github Actions workflow triggered on git tag <code>update-<version></code> that builds whole docs with api and publishes them to <a href="https://github.com/FlaxEngine/FlaxDocsHost">FlaxDocsHost</a> for static hosting on Github Pages.</li>
<li><code>.github\workflows\docs-build.yml</code> - Github Actions workflow triggered on push/pr that builds manual without api to verify the integrity of the modified docs (eg. warns about invalid links or missing files).</li>
</ul>
<h2 id="licensing">Licensing</h2>
<p><a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png"></a><br><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">FlaxDocs</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/FlaxEngine/FlaxDocs/blob/0d22a7e82b67dcb5002e612b55849773b38d4583/README.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2012-2024 Wojciech Figat
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>