Wire the site with spec and ceylondoc
The site now integrates the specification and the ceylondoc for ceylon.language.
How to build the integrated site
Run ./build-site.sh from the root of your ceylon-lang.org repository.
This will
- clone or refresh the ceylon-spec, ceylon.language and ceylon-compiler repos
- build the documentation as of the latest in master
- push the bits in the generated directory of awestruct
How to reference the spec or the ceylondoc
This information is out dated and has changed in later versions of the website, check out our how to edit a page section.
If you want to point the spec to a user in the site, point to /documentation/1.0/spec. This page show the spec in HTML, HTML in single page and PDF.
If you want to point to a specific paragraph in the spec, use the variable site.urls.spec.current and
the anchor to the paragraph in the spec.
eg This is a [pointer to the spec](#{site.urls.spec}#anchor-in-spec).
That means the specification anchors should be stable.
Likewise, to point to a ceylondoc entry, use the variable site.urls.apidocs.
[Doc for Comparable](#{site.urls.apidoc_current}/ceylon/language/Comparable.html)
By using these placeholders, we will be able to move the spec or ceylondoc to other places. Note that /documentation/1.0/api page is pretty useless as it is but should be fixed in ceylondoc.
