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

Commit

Permalink
integrate new documentation system which parses docs out of javascrip…
Browse files Browse the repository at this point in the history
…t source. Closes #48
  • Loading branch information
lloyd committed Jan 25, 2011
2 parents 8d87e8e + 137731a commit 420f86a
Show file tree
Hide file tree
Showing 60 changed files with 2,279 additions and 1,422 deletions.
268 changes: 130 additions & 138 deletions docs/css/apidocs.css
Original file line number Diff line number Diff line change
@@ -1,138 +1,130 @@
/*
Some global styles for api_refernece
*/

.api_reference p
{
margin-top: 0px;
margin-bottom: 5px;
}

.api_reference .datatype
{
font-style: italic;
}

/***
HEADINGS
Text title for some collection of API elements, like "Properties" or "Methods".
***/

/* generic style for all headers */
.api_header
{
font-weight: bold;
}

/* top level heading: something like "API Reference" */
h2.api_header
{
font-size: 200%;
margin-top:30px;
margin-bottom:10px;
}

/* next-level heading: something like "Classes", "Global Functions" */
h3.api_header
{
font-size: 150%;
margin-top:20px;
margin-bottom:10px;
padding: 3px;
border: solid 1px #EEE;
background: #EEE;
}

/* next-level heading: something like "Methods", "Object properties" */
.api_reference>.api_component_group>.api_component>.api_component_group>.api_header
{
font-size: 125%;
margin-top:20px;
margin-bottom:5px;
border-bottom: solid 2px #EEE;
}

/***
NAMES
Name of some API component, like widget or postMessage()
***/

/* default style for all names */
.api_name
{
font-weight: bold;
}

/* top level api component: module-level classes,functions, properties */
h4.api_name
{
font-weight: normal;
font-size: 150%;
padding: 3px;
border: solid 1px #EEE;
background: #EEE;
margin-bottom:5px;
}

/* next level API component: methods or object properties */
.api_reference>.api_component_group>.api_component>.api_component_group>.api_component>.api_name
{
font-size: 120%;
font-weight: bold;
margin-bottom:0px;
}

/***
Spacing components and component groups
***/

/*
Top level API component, like a global class, function, or property
*/
.api_reference>.api_component_group>.api_component
{
margin-bottom: 50px;
}

/*
Next-level API component, like a class method
*/
.api_reference>.api_component_group>.api_component>.api_component_group>.api_component
{
margin-bottom: 20px;
}

/*
All collections of API components
*/
.api_component_group
{
margin-bottom: 30px;
}

/***PARAMETERS and RETURNS***/
/*
Parameters and returns have a grey background
*/
.parameter_set, .returns
{
background-color: #EEE;
}

/*
Parameter components are divided by a thin border
*/
.parameter_set .api_component
{
padding: 3px;
border-top: 2px solid rgba(255,255,255,.3);
}

/*
Subcomponents of parameters are indented
*/
.parameter_set>.api_component>.api_component
{
padding-left: 20px;
}

.module-detail > div.name {
font-weight: bold;
font-size: 2em;
}

.module-detail .package a {
color: gray;
}

.module-detail .example {
width: 100%;
background: #ccc;
padding: .5em;
background-color: .2em;
margin: 2em;
}

.one-property .invocation, .one-function .invocation {
font-family: Monaco, Lucida Console, monospace;
font-size: 1.1em;
}

.one-property .invocation .propName, .one-function .invocation .funcName {
font-weight: bold;
}

.one-property .description, .one-function .description, .one-function .parameters, .one-function .returnvalue {
margin: 1em;
margin-left: 2em;
}

.one-function {
margin-bottom: 1em;
}

.one-function .type, .one-property .type {
color: gray;
margin-right: .65em;
}

.one-function .paramdoc {
margin-top: 1em;
}

.one-function .paramdoc, .paramdoc tr, .one-function .paramdoc td {
border: none;
padding: 0;
vertical-align: top;
}

.one-function .paramdoc td p {
margin-bottom: .7em;
}

.one-function .paramdoc .paramname {
font-size: 1.1em;
font-style: italic;
width: 6em;
}

.one-function .littleheading, .class-detail .littleheading {
font-weight: bold;
}

.class-detail .littleheading {
margin: 1em 0 1em;
}

.class-detail {
margin-left: 2em;
}

.class-detail .classname {
font-family: Monaco, Lucida Console, monospace;
font-size: 1.5em;
}

.full-api .filter_container {
width: 100%;
background-color: #333;
border-radius: 5px;
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
align: center;
padding: 10px;
margin: 1em;
height: 3em;
}

.full-api .prompt {
color:#eee;
font-style: italic;
font-size: 1.2em;
padding-right: 10px;
margin-top: .4em;
}

.full-api input {
border: 0;
padding: .5em;
border-radius: .3em;
-moz-border-radius: .3em;
-webkit-border-radius: .3em;
}

.full-api .filter_container > * {
float: left;
}

.full-api .filter_container .clear {
margin: 0;
width: 1em;
height: 1.5em;
padding: .1em .3em 0 .3em;
text-align: center;
vertical-align: center;
background-color: #ccc;
border-radius: .8em;
-moz-border-radius: .8em;
-webkit-border-radius: .8em;
font-size: .8em;
font-weight: bold;
margin-top: .65em;
margin-left: .7em;
cursor: pointer;
}

.full-api a {
text-decoration: none;
}
39 changes: 39 additions & 0 deletions docs/css/packages.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.one-package {
padding-bottom:1.5em;
}

.one-package .name a {
font-size: 120%;
font-weight: bold;
color: gray;
}

.one-package .numfiles {
color: gray;
font-style: italic;
}

.one-package .files {
padding: 1em;
}

.one-package .module {
display: inline;
margin-right: 1em;
white-space: nowrap;
}
.one-package .module a {
text-decoration: none;
color: gray;
font-size: .9em;
}

.package-detail .module-name {
font-size: 1.3em;
font-weight: bold;
margin-top: 1em;
}

.package-detail .module-desc {
margin: 0 2em 0 2em;
}
Loading

0 comments on commit 420f86a

Please sign in to comment.