Skip to content
This repository has been archived by the owner on Sep 15, 2021. It is now read-only.

Commit

Permalink
Update and fix URLS for new domain name and HTTPS. (#29)
Browse files Browse the repository at this point in the history
Fixes #27
  • Loading branch information
davidzchen authored Nov 16, 2016
1 parent bedfa0a commit 71d74c1
Show file tree
Hide file tree
Showing 16 changed files with 29 additions and 27 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ possibly guide you.

### Code reviews and other contributions.
**All submissions, including submissions by project members, require review.**
Please follow the instructions in [the contributors documentation](http://bazel.io/contributing.html).
Please follow the instructions in [the contributors documentation](https://bazel.build/contributing.html).

### The small print
Contributions made by corporations are covered by a different agreement than
Expand Down
2 changes: 1 addition & 1 deletion serve-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function build_and_serve {
pkill -9 jekyll || true

if [ -z "$TARGET" ]; then
echo "Serving skydoc.bazel.io site at port $PORT"
echo "Serving skydoc.bazel.build site at port $PORT"
jekyll serve --detach --quiet --port "$PORT" --source "$WORKING_DIR"
else
TMP_TARGET=$(mktemp -d)
Expand Down
2 changes: 1 addition & 1 deletion site/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
skydoc.bazel.io
skydoc.bazel.build
2 changes: 1 addition & 1 deletion site/_includes/drawer.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<li><a href="/contributing.html">Contribute to Skydoc</a></li>
<li><a href="/roadmap.html">Roadmap</a></li>
<li><a href="https://groups.google.com/forum/#!forum/bazel-discuss">User mailing list</a></li>
<li><a href="https://github.com/bazelbuild/tulsi/issues">Issue tracker</a></li>
<li><a href="https://github.com/bazelbuild/skydoc/issues">Issue tracker</a></li>
<li><a href="https://github.com/bazelbuild/skydoc">GitHub</a></li>
</ul>
</li>
Expand Down
2 changes: 1 addition & 1 deletion site/_includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
var current_url = window.location.href;
var bad_url = new RegExp("^https?://bazelbuild.github.io/skydoc/");
if (bad_url.test(current_url)) {
window.location.replace(current_url.replace(bad_url, "http://skydoc.bazel.io/"));
window.location.replace(current_url.replace(bad_url, "https://skydoc.bazel.build/"));
}
</script>

Expand Down
2 changes: 1 addition & 1 deletion site/_sass/base.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2016 The Tulsi Authors. All rights reserved.
// Copyright 2016 The Skydoc Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion site/_sass/docs.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2016 The Tulsi Authors. All rights reserved.
// Copyright 2016 The Skydoc Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion site/_sass/drawer.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2016 The Tulsi Authors. All rights reserved.
// Copyright 2016 The Skydoc Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion site/_sass/home.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2016 The Tulsi Authors. All rights reserved.
// Copyright 2016 The Skydoc Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion site/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ a lot of time in a patch.
To submit a patch to Skydoc:

* Skydoc is part of the Bazel project. Read the [Bazel governance
plan](http://www.bazel.io/governance.html) and Skydoc's [contribution
plan](https://www.bazel.build/governance.html) and Skydoc's [contribution
guidelines](https://github.com/bazelbuild/skydoc/blob/master/CONTRIBUTING.md).
* Open an [Issue](https://github.com/bazelbuild/skydoc/issues) or discuss your
plan or design on the [bazel-dev][bazel-dev] mailing list.
Expand Down
6 changes: 3 additions & 3 deletions site/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ suggest using the `dict(a.items() + b.items())` syntax instead.

[dict-op]: https://github.com/bazelbuild/bazel/issues/1086

## Is Skydoc used to generate the documentation on [Bazel.io](http://bazel.io)?
## Is Skydoc used to generate the documentation on [Bazel.io](https://bazel.build)?

Not for now. The [Build Encyclopedia](http://bazel.io/docs/be/overview.html)
Not for now. The [Build Encyclopedia](https://bazel.build/docs/be/overview.html)
documents the set of native Bazel build rules written in Java, and the
[Skylark Library](http://bazel.io/docs/skylark/lib/globals.html) documents the
[Skylark Library](https://bazel.build/docs/skylark/lib/globals.html) documents the
built-in Skylark modules and functions. Because both of these sets of docs are
generated from Bazel's Java source code, they are generated using a [separate
documentation generation
Expand Down
6 changes: 3 additions & 3 deletions site/docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ layout: default
title: Getting started
---

Skydoc is a documentation generator for [Bazel](http://bazel.io) build rules
written in [Skylark](http://bazel.io/docs/skylark/index.html).
Skydoc is a documentation generator for [Bazel](https://bazel.build) build rules
written in [Skylark](https://bazel.build/docs/skylark/index.html).

Skydoc provides a set of Skylark rules (`skylark_library` and `skylark_doc`)
that can be used to build documentation for Skylark rules in either Markdown or
HTML. Skydoc generates one documentation page per `.bzl` file.

If you are new to writing build rules for Bazel, please read the Bazel
documentation on [writing
extensions](http://www.bazel.io/docs/skylark/concepts.html)
extensions](https://www.bazel.build/docs/skylark/concepts.html)

<img src="/images/screenshot.png" class="responsive"
alt="A screenshot of Skydoc generated HTML documentation">
Expand Down
10 changes: 5 additions & 5 deletions site/docs/writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ appear in generated documentation.
<a name="rule-documentation"></a>
## Rule Documentation

[Skylark Rules](http://bazel.io/docs/skylark/rules.html) are declared using the
`rule()` function as global variables. As a result, they are documented using
variable docstrings, similar to those supported by
[Skylark Rules](https://bazel.build/docs/skylark/rules.html) are declared using
the `rule()` function as global variables. As a result, they are documented
using variable docstrings, similar to those supported by
[epydoc](http://epydoc.sourceforge.net/manual-docstring.html).

Attributes are documented in a special `Args:` section. Begin the documentation
Expand Down Expand Up @@ -68,8 +68,8 @@ in `Args`.
<a name="macro-documentation"></a>
## Macro Documentation

[Skylark Macros](http://bazel.io/docs/skylark/macros.html) are Python functions
and are thus documented using function docstrings:
[Skylark Macros](https://bazel.build/docs/skylark/macros.html) are Python
functions and are thus documented using function docstrings:

```python
def rat_check(name, srcs=[], format, visibility):
Expand Down
4 changes: 2 additions & 2 deletions site/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: Roadmap
* Enable greater customization of generated documentation, such as adding custom
HTML and CSS to the documentation pages.
* Improve documentation for Skylark
[Aspects](http://www.bazel.io/docs/skylark/aspects.html) and
[Repository Rules](http://www.bazel.io/docs/skylark/repository_rules.html).
[Aspects](https://www.bazel.build/docs/skylark/aspects.html) and
[Repository Rules](https://www.bazel.build/docs/skylark/repository_rules.html).
8 changes: 5 additions & 3 deletions skydoc/rule.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@
class Attribute(object):
"""Representation of an attribute used to render documentation templates."""

NAME_LINK = '<a href="http://bazel.io/docs/build-ref.html#name">Name</a>'
LABEL_LINK = '<a href="http://bazel.io/docs/build-ref.html#labels">Label</a>'
NAME_LINK = (
'<a href="https://bazel.build/docs/build-ref.html#name">Name</a>')
LABEL_LINK = (
'<a href="https://bazel.build/docs/build-ref.html#labels">Label</a>')
LABELS_LINK = (
'<a href="http://bazel.io/docs/build-ref.html#labels">labels</a>')
'<a href="https://bazel.build/docs/build-ref.html#labels">labels</a>')

def __init__(self, proto):
self.__proto = proto
Expand Down
2 changes: 1 addition & 1 deletion skydoc/templates/html.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Documentation generated by Skydoc
<div class="mdl-mini-footer__left-section">
<div class="mdl-logo">Bazel</div>
<ul class="mdl-mini-footer__link-list">
<li><a href="http://bazel.io">Home</a></li>
<li><a href="https://bazel.build">Home</a></li>
<li><a href="https://github.com/bazelbuild">GitHub</a></li>
</ul>
</div>
Expand Down

0 comments on commit 71d74c1

Please sign in to comment.