From 6512af04bad7435ca2e51f4ba8fb069ba318e456 Mon Sep 17 00:00:00 2001 From: Artem Titov Date: Mon, 1 Mar 2021 17:30:29 +0100 Subject: [PATCH] Add root doc site definition for WebRTC documentation Bug: None Change-Id: I64f5a356e0358360bd8326c39c8b0a898b879ebf Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/208641 Commit-Queue: Artem Titov Reviewed-by: Mirko Bonadei Reviewed-by: Harald Alvestrand Cr-Commit-Position: refs/heads/master@{#33360} --- api/DEPS | 1 + g3doc/g3doc.lua | 18 + g3doc/index.md | 6 + g3doc/logo.svg | 675 +++++++++++++++++++++++++++++++++++ g3doc/sitemap.md | 6 + test/network/g3doc/g3doc.lua | 5 + test/network/g3doc/index.md | 5 +- test/pc/e2e/g3doc/g3doc.lua | 10 +- 8 files changed, 717 insertions(+), 9 deletions(-) create mode 100644 g3doc/g3doc.lua create mode 100644 g3doc/index.md create mode 100644 g3doc/logo.svg create mode 100644 g3doc/sitemap.md create mode 100644 test/network/g3doc/g3doc.lua diff --git a/api/DEPS b/api/DEPS index 52de6c37c8..bf814e82d3 100644 --- a/api/DEPS +++ b/api/DEPS @@ -11,6 +11,7 @@ include_rules = [ "-common_video", "-data", "-examples", + "-g3doc", "-ios", "-infra", "-logging", diff --git a/g3doc/g3doc.lua b/g3doc/g3doc.lua new file mode 100644 index 0000000000..c6ab1626df --- /dev/null +++ b/g3doc/g3doc.lua @@ -0,0 +1,18 @@ +return { + theme = { + '@builtins/theme/ng.md' + -- We don't want to have more than h3 headings in the Table Of Content. + --toc_level = 3, + }, + + site = { + name = 'WebRTC C++ library', + home = '/g3doc/index.md', + logo = '/g3doc/logo.svg', + map = '/g3doc/sitemap.md', + }, + + visibility = { '/...' }, + + freshness = {} +} diff --git a/g3doc/index.md b/g3doc/index.md new file mode 100644 index 0000000000..50a3934a4e --- /dev/null +++ b/g3doc/index.md @@ -0,0 +1,6 @@ +# WebRTC C++ library + + + + +This is a home page for WebRTC C++ library documentation diff --git a/g3doc/logo.svg b/g3doc/logo.svg new file mode 100644 index 0000000000..634b8cb116 --- /dev/null +++ b/g3doc/logo.svg @@ -0,0 +1,675 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/g3doc/sitemap.md b/g3doc/sitemap.md new file mode 100644 index 0000000000..8fa28be3f2 --- /dev/null +++ b/g3doc/sitemap.md @@ -0,0 +1,6 @@ +* Testing + * Media Quality and performance + * PeerConnection Framework + * [Video analyzer](/test/pc/e2e/g3doc/default_video_quality_analyzer.md) + * Network emulation + * [Implementation](/test/network/g3doc/index.md) diff --git a/test/network/g3doc/g3doc.lua b/test/network/g3doc/g3doc.lua new file mode 100644 index 0000000000..af07b58b77 --- /dev/null +++ b/test/network/g3doc/g3doc.lua @@ -0,0 +1,5 @@ +config = require('/g3doc/g3doc.lua') + +config.freshness.owner = 'titovartem' + +return config diff --git a/test/network/g3doc/index.md b/test/network/g3doc/index.md index 908e0e2ca6..5d511916c1 100644 --- a/test/network/g3doc/index.md +++ b/test/network/g3doc/index.md @@ -1,9 +1,6 @@ # Network Emulation Framework - + [TOC] diff --git a/test/pc/e2e/g3doc/g3doc.lua b/test/pc/e2e/g3doc/g3doc.lua index 1cc19136ab..af07b58b77 100644 --- a/test/pc/e2e/g3doc/g3doc.lua +++ b/test/pc/e2e/g3doc/g3doc.lua @@ -1,5 +1,5 @@ -return { - freshness = { - owner = 'titovartem', - } -} +config = require('/g3doc/g3doc.lua') + +config.freshness.owner = 'titovartem' + +return config