summaryrefslogtreecommitdiff
path: root/doc/docfx
diff options
context:
space:
mode:
Diffstat (limited to 'doc/docfx')
-rw-r--r--doc/docfx/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/docfx/README b/doc/docfx/README
index a35110cccf..05925bb462 100644
--- a/doc/docfx/README
+++ b/doc/docfx/README
@@ -25,4 +25,22 @@ repository and adapt them to the DocFX syntax.
25Finally, run the `gendoc.sh` script (also from this folder) to produce the HTML 25Finally, run the `gendoc.sh` script (also from this folder) to produce the HTML
26files. First run can take a long time (from 10' to 1h), subsequent runs use 26files. First run can take a long time (from 10' to 1h), subsequent runs use
27cached results and take about 5 minutes. 27cached results and take about 5 minutes.
28The result can be found in the _site folder.
28 29
30DEPLOYMENT
31----------
32
33This is the manual deployment process currently in use. It could certainly
34be improved and automated.
35The HTML files produced by DocFX are currently hosted using GitHub pages.
36The Enlightenment site's content is hosted in the www-content repository:
37https://git.enlightenment.org/website/www-content.git/
38This repo is mirrored at GitHub:
39https://github.com/Enlightenment/www-content
40The GitHub mirror has a branch called "gh-pages" which has a "gh-pages"
41folder at the root.
42
43Whenever new documentation is generated, just copy the _site folder from
44/doc/docfx in the EFL repo to /gh-pages/api/csharp in the www-content repo
45(gh-pages branch!) and push to the GitHub mirror.
46Changes should be visible almost instantly, since they are static pages.