Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit 7627e8a

Browse files
chingor13chingor13
authored
Add API documentation builder configuration (#64)
* Generate documentation using sami * Only build current branch for now, until this is in master * Add license header to sami config file * Update docs with latest changes from master
1 parent fd401f3 commit 7627e8a

79 files changed

Lines changed: 17281 additions & 0 deletions

Some content is hidden

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

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.DS_Store
22
build/
3+
cache/
34
composer.phar
45
composer.lock
56
docs/json/**/*

‎config/sami.php‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?php
2+
/**
3+
* Copyright 2017 OpenCensus Authors
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
use Sami\Sami;
19+
// use Sami\Version\GitVersionCollection;
20+
use Symfony\Component\Finder\Finder;
21+
22+
$root_dir = __DIR__ . '/../';
23+
24+
$iterator = Finder::create()
25+
->files()
26+
->name('*.php')
27+
->in(__DIR__ . '/../src');
28+
29+
// $versions = GitVersionCollection::create($root_dir)
30+
// ->addFromTags('v0.*')
31+
// ->add('master', 'master branch');
32+
33+
return new Sami($iterator, [
34+
// 'versions' => $versions,
35+
'build_dir' => __DIR__ . '/../docs'
36+
]);

‎docs/OpenCensus.html‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="robots" content="index, follow, all" />
6+
<title>OpenCensus | API</title>
7+
8+
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
9+
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
10+
<link rel="stylesheet" type="text/css" href="css/sami.css">
11+
<script src="js/jquery-1.11.1.min.js"></script>
12+
<script src="js/bootstrap.min.js"></script>
13+
<script src="js/typeahead.min.js"></script>
14+
<script src="sami.js"></script>
15+
<meta name="MobileOptimized" content="width">
16+
<meta name="HandheldFriendly" content="true">
17+
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
18+
19+
20+
</head>
21+
22+
<body id="namespace" data-name="namespace:OpenCensus" data-root-path="">
23+
<div id="content">
24+
<div id="left-column">
25+
<div id="control-panel">
26+
<script>
27+
$('option[data-version="'+window.projectVersion+'"]').prop('selected', true);
28+
</script>
29+
<form id="search-form" action="search.html" method="GET">
30+
<span class="glyphicon glyphicon-search"></span>
31+
<input name="search"
32+
class="typeahead form-control"
33+
type="search"
34+
placeholder="Search">
35+
</form>
36+
</div>
37+
38+
<div id="api-tree"></div>
39+
40+
</div>
41+
<div id="right-column">
42+
<nav id="site-nav" class="navbar navbar-default" role="navigation">
43+
<div class="container-fluid">
44+
<div class="navbar-header">
45+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
46+
<span class="sr-only">Toggle navigation</span>
47+
<span class="icon-bar"></span>
48+
<span class="icon-bar"></span>
49+
<span class="icon-bar"></span>
50+
</button>
51+
<a class="navbar-brand" href="index.html">API</a>
52+
</div>
53+
<div class="collapse navbar-collapse" id="navbar-elements">
54+
<ul class="nav navbar-nav">
55+
<li><a href="classes.html">Classes</a></li>
56+
<li><a href="namespaces.html">Namespaces</a></li>
57+
<li><a href="interfaces.html">Interfaces</a></li>
58+
<li><a href="traits.html">Traits</a></li>
59+
<li><a href="doc-index.html">Index</a></li>
60+
<li><a href="search.html">Search</a></li>
61+
</ul>
62+
</div>
63+
</div>
64+
</nav>
65+
66+
<div class="namespace-breadcrumbs">
67+
<ol class="breadcrumb">
68+
<li><span class="label label-default">Namespace</span></li>
69+
<li><a href="OpenCensus.html">OpenCensus</a></li><li class="backslash">\</li>
70+
</ol>
71+
</div>
72+
<div id="page-content">
73+
74+
<div class="page-header">
75+
<h1>OpenCensus</h1>
76+
</div>
77+
78+
<h2>Namespaces</h2>
79+
<div class="namespace-list">
80+
<a href="OpenCensus/Core.html">OpenCensus\Core</a><a href="OpenCensus/Trace.html">OpenCensus\Trace</a> </div>
81+
82+
83+
84+
85+
</div>
86+
<div id="footer">
87+
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
88+
</div>
89+
90+
</div>
91+
</div>
92+
</body>
93+
94+
</html>

‎docs/OpenCensus/Core.html‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="robots" content="index, follow, all" />
6+
<title>OpenCensus\Core | API</title>
7+
8+
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
9+
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
10+
<link rel="stylesheet" type="text/css" href="../css/sami.css">
11+
<script src="../js/jquery-1.11.1.min.js"></script>
12+
<script src="../js/bootstrap.min.js"></script>
13+
<script src="../js/typeahead.min.js"></script>
14+
<script src="../sami.js"></script>
15+
<meta name="MobileOptimized" content="width">
16+
<meta name="HandheldFriendly" content="true">
17+
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
18+
19+
20+
</head>
21+
22+
<body id="namespace" data-name="namespace:OpenCensus_Core" data-root-path="../">
23+
<div id="content">
24+
<div id="left-column">
25+
<div id="control-panel">
26+
<script>
27+
$('option[data-version="'+window.projectVersion+'"]').prop('selected', true);
28+
</script>
29+
<form id="search-form" action="../search.html" method="GET">
30+
<span class="glyphicon glyphicon-search"></span>
31+
<input name="search"
32+
class="typeahead form-control"
33+
type="search"
34+
placeholder="Search">
35+
</form>
36+
</div>
37+
38+
<div id="api-tree"></div>
39+
40+
</div>
41+
<div id="right-column">
42+
<nav id="site-nav" class="navbar navbar-default" role="navigation">
43+
<div class="container-fluid">
44+
<div class="navbar-header">
45+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
46+
<span class="sr-only">Toggle navigation</span>
47+
<span class="icon-bar"></span>
48+
<span class="icon-bar"></span>
49+
<span class="icon-bar"></span>
50+
</button>
51+
<a class="navbar-brand" href="../index.html">API</a>
52+
</div>
53+
<div class="collapse navbar-collapse" id="navbar-elements">
54+
<ul class="nav navbar-nav">
55+
<li><a href="../classes.html">Classes</a></li>
56+
<li><a href="../namespaces.html">Namespaces</a></li>
57+
<li><a href="../interfaces.html">Interfaces</a></li>
58+
<li><a href="../traits.html">Traits</a></li>
59+
<li><a href="../doc-index.html">Index</a></li>
60+
<li><a href="../search.html">Search</a></li>
61+
</ul>
62+
</div>
63+
</div>
64+
</nav>
65+
66+
<div class="namespace-breadcrumbs">
67+
<ol class="breadcrumb">
68+
<li><span class="label label-default">Namespace</span></li>
69+
<li><a href="../OpenCensus.html">OpenCensus</a></li><li class="backslash">\</li><li><a href="../OpenCensus/Core.html">Core</a></li><li class="backslash">\</li>
70+
</ol>
71+
</div>
72+
<div id="page-content">
73+
74+
<div class="page-header">
75+
<h1>OpenCensus\Core</h1>
76+
</div>
77+
78+
79+
<h2>Classes</h2>
80+
81+
<div class="container-fluid underlined">
82+
<div class="row">
83+
<div class="col-md-6">
84+
<a href="../OpenCensus/Core/Context.html"><abbr title="OpenCensus\Core\Context">Context</abbr></a>
85+
86+
</div>
87+
<div class="col-md-6">
88+
This class is an implementation of a generic context.
89+
</div>
90+
</div>
91+
</div>
92+
93+
94+
95+
</div>
96+
<div id="footer">
97+
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
98+
</div>
99+
100+
</div>
101+
</div>
102+
</body>
103+
104+
</html>

0 commit comments

Comments
 (0)