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

Commit 4e6ca09

Browse files
authored
Build versioned docs (#172)
* Build all tagged and master branch versioned docs * Update link docs to master branch * Fix base_url for hugo site * Update README links to point to moved docs
1 parent 2bbf046 commit 4e6ca09

File tree

4 files changed

+24
-22
lines changed

4 files changed

+24
-22
lines changed

.travis.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ script:
1111
- pushd docs
1212
- hugo
1313
- popd
14-
- php sami.phar update config/sami.php
14+
- cp config/sami.php config/sami-config.php
15+
- php sami.phar update config/sami-config.php
1516
- touch docs/.nojekyll
1617

1718
branches:

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -155,21 +155,21 @@ Apache 2.0 - See [LICENSE](LICENSE) for more information.
155155
This is not an official Google product.
156156
157157
[census-org]: https://github.com/census-instrumentation
158-
[api-docs]: https://census-instrumentation.github.io/opencensus-php/api
159-
[integration-docs]: https://census-instrumentation.github.io/opencensus-php
158+
[api-docs]: https://opencensus.io/api/php/api/master/
159+
[integration-docs]: https://opencensus.io/api/php
160160
[composer]: https://getcomposer.org/
161161
[pecl]: https://pecl.php.net/
162-
[never-sampler]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Sampler/NeverSampleSampler.html
163-
[always-sampler]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Sampler/NeverSampleSampler.html
164-
[multi-sampler]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Sampler/MultiSampler.html
165-
[qps-sampler]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Sampler/NeverSampleSampler.html
166-
[probability-sampler]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Sampler/NeverSampleSampler.html
167-
[echo-exporter]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Exporter/EchoExporter.html
168-
[file-exporter]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Exporter/FileExporter.html
162+
[never-sampler]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Sampler/NeverSampleSampler.html
163+
[always-sampler]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Sampler/NeverSampleSampler.html
164+
[multi-sampler]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Sampler/MultiSampler.html
165+
[qps-sampler]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Sampler/NeverSampleSampler.html
166+
[probability-sampler]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Sampler/NeverSampleSampler.html
167+
[echo-exporter]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Exporter/EchoExporter.html
168+
[file-exporter]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Exporter/FileExporter.html
169169
[jaeger-exporter]: https://github.com/census-instrumentation/opencensus-php-exporter-jaeger/blob/master/src/JaegerExporter.php
170170
[jaeger-packagist]: https://packagist.org/packages/opencensus/opencensus-exporter-jaeger
171-
[logger-exporter]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Exporter/LoggerExporter.html
172-
[null-exporter]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Exporter/NullExporter.html
173-
[stackdriver-exporter]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Exporter/StackdriverExporter.html
174-
[zipkin-exporter]: https://census-instrumentation.github.io/opencensus-php/api/OpenCensus/Trace/Exporter/ZipkinExporter.html
171+
[logger-exporter]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Exporter/LoggerExporter.html
172+
[null-exporter]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Exporter/NullExporter.html
173+
[stackdriver-exporter]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Exporter/StackdriverExporter.html
174+
[zipkin-exporter]: https://opencensus.io/api/php/api/master/OpenCensus/Trace/Exporter/ZipkinExporter.html
175175
[semver]: http://semver.org/

config/sami.php

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
*/
1717

1818
use Sami\Sami;
19-
// use Sami\Version\GitVersionCollection;
19+
use Sami\Version\GitVersionCollection;
2020
use Symfony\Component\Finder\Finder;
2121
use Sami\Parser\Filter\FilterInterface;
2222
use Sami\Reflection\ClassReflection;
@@ -30,14 +30,15 @@
3030
->name('*.php')
3131
->in(__DIR__ . '/../src');
3232

33-
// $versions = GitVersionCollection::create($root_dir)
34-
// ->addFromTags('v0.*')
35-
// ->add('master', 'master branch');
33+
$versions = GitVersionCollection::create($root_dir)
34+
->addFromTags('v0.*')
35+
->add('master', 'master branch');
3636

3737
$sami = new Sami($iterator, [
38-
// 'versions' => $versions,
39-
'build_dir' => __DIR__ . '/../docs/public/api',
40-
'title' => 'OpenCensus PHP API'
38+
'versions' => $versions,
39+
'build_dir' => __DIR__ . '/../docs/public/api/%version%/',
40+
'title' => 'OpenCensus PHP API',
41+
'cache_dir' => __DIR__ . '/../cache/%version%/'
4142
]);
4243

4344
class VisibleFilter implements FilterInterface

docs/config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
baseURL = "https://census-instrumentation.github.io/opencensus-php/"
1+
baseURL = "https://opencensus.io/api/php/"
22
languageCode = "en-us"
33
title = "OpenCensus for PHP"
44
theme = "hyde"

0 commit comments

Comments
 (0)