How do I build the docs locally?

> On Aug 16, 2020, at 1:50 PM, carlosrov...@apache.org wrote:
> 
> This is an automated email from the ASF dual-hosted git repository.
> 
> carlosrovira pushed a commit to branch master
> in repository https://gitbox.apache.org/repos/asf/royale-docs.git
> 
> 
> The following commit(s) were added to refs/heads/master by this push:
>     new 705365c  start docs for List and ButtonBar
> 705365c is described below
> 
> commit 705365c83baad78142176b7c80e6197cd25dbd61
> Author: Carlos Rovira <carlos.rov...@apache.org>
> AuthorDate: Sun Aug 16 12:50:30 2020 +0200
> 
>    start docs for List and ButtonBar
> ---
> component-sets/jewel.md                 |  4 ++--
> component-sets/jewel/jewel-buttonbar.md | 16 ++++++++++++++--
> component-sets/jewel/jewel-list.md      | 16 ++++++++++++++--
> 3 files changed, 30 insertions(+), 6 deletions(-)
> 
> diff --git a/component-sets/jewel.md b/component-sets/jewel.md
> index bdfd6ed..6157a0d 100644
> --- a/component-sets/jewel.md
> +++ b/component-sets/jewel.md
> @@ -58,7 +58,7 @@ If the component name is a link, you can click it to see 
> more information about
> | Type                | Name                                                  
> | Description                                                                 
>      | Available SDK         | State         |
> |------------------   |------------------------------------------------------ 
> |---------------------------------------------------------------------------------
>  |------------------ |-------------- |
> | __Containers__      | [Application](component-sets/jewel/application)       
>                                       | The root container of a Jewel 
> Application                                      | 0.9.4             | 
> Complete      |
> -|                    | ButtonBar                                             
> | Container that displays a series of buttons                                 
>      | 0.9.7             | Complete      |
> +|                    | [ButtonBar](component-sets/jewel/buttonbar)           
>                                   | Container that displays a series of 
> buttons                                      | 0.9.7             | Complete   
>    |
> |                 | [Card](component-sets/jewel/card)                     | 
> Content (text, images,...) container with optional title and actions zones    
>    | 0.9.4             | Complete      |
> |                 | [Container](component-sets/jewel/container)           | 
> Container that surrounds other components                                     
>    | 0.9.4             | Complete      |
> |                 | [DataContainer](component-sets/jewel/datacontainer)   | A 
> Container that creates child elements dynamically based on a data provider    
>  | 0.9.4             | Complete      |
> @@ -82,7 +82,7 @@ If the component name is a link, you can click it to see 
> more information about
> |                     | Icon                      |                           
>                                                                               
>   | 0.9.4         | Complete |
> |                     | Image                    |                            
>                                                                               
>   | 0.9.4         | Complete |
> |                     | [Label](component-sets/jewel/label)                   
>     |  Used for single or multi lined text labels                             
>           | 0.9.4         | Complete      |
> -|                    | List                      |                           
>                                                                               
>   | 0.9.4         | Complete |
> +|                    | [List](component-sets/jewel/list) | A data container 
> that support selection of items                                               
>                                                            | 0.9.4         | 
> Complete |
> |                     | NumericStepper  |                                     
>                                                                         | 
> 0.9.4                 |               |
> |                     | PopUp                    |                            
>                                                                               
>   | 0.9.4         | Complete |
> |                     | [RadioButton](component-sets/jewel/radiobutton)       
>     | Lets the user make a single choice within a set of mutually exclusive 
> choices     | 0.9.4                 | Complete      |
> diff --git a/component-sets/jewel/jewel-buttonbar.md 
> b/component-sets/jewel/jewel-buttonbar.md
> index 31e4f09..24bb8a3 100644
> --- a/component-sets/jewel/jewel-buttonbar.md
> +++ b/component-sets/jewel/jewel-buttonbar.md
> @@ -23,6 +23,18 @@ permalink: /component-sets/jewel/buttonbar
> 
> # Jewel ButtonBar
> 
> -subtitle
> +Available since version __0.9.4__.
> 
> -text
> +| Class                          | Extends                           |
> +|------------------------------      |----------------------------------     
> |
> +| 
> [org.apache.royale.jewel.ButtonBar](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/ButtonBar){:target='_blank'}
>  | 
> [org.apache.royale.jewel.List](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/List){:target='_blank'}
>  |
> +
> +<sup>_Note: This component is currently only available for JavaScript._</sup>
> +
> +## Overview
> +
> +The Jewel ButtonBar class is a component that displays a set of Buttons. The 
> ButtonBar is actually a List with a default horizontal layout and an 
> itemRenderer that produces Jewel Buttons.
> +
> +## Relevant Properties and Methods
> +
> +> Check the Reference of 
> [org.apache.royale.jewel.ButtonBar](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/ButtonBar){:target='_blank'}
>  for a more detailed list of properties and methods.
> \ No newline at end of file
> diff --git a/component-sets/jewel/jewel-list.md 
> b/component-sets/jewel/jewel-list.md
> index e03d236..c485315 100644
> --- a/component-sets/jewel/jewel-list.md
> +++ b/component-sets/jewel/jewel-list.md
> @@ -23,6 +23,18 @@ permalink: /component-sets/jewel/list
> 
> # Jewel List
> 
> -subtitle
> +Available since version __0.9.4__.
> 
> -text
> +| Class                          | Extends                           | 
> Implements                        |
> +|------------------------------      |----------------------------------     
> |---------------------------------  |
> +| 
> [org.apache.royale.jewel.List](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/List){:target='_blank'}
>  | 
> [DataContainer](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/DataContainer){:target='_blank'}
>  | 
> [IStrand](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IStrand){:target='_blank'},
>  
> [IVariableRowHeight](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.layouts/IVariableRowHeight){:target='_blank'}
>  |
> +
> +<sup>_Note: This component is currently only available for JavaScript._</sup>
> +
> +## Overview
> +
> +The List class is a component that displays multiple data items and provides 
> selection.
> +
> +## Relevant Properties and Methods
> +
> +> Check the Reference of 
> [org.apache.royale.jewel.List](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/List){:target='_blank'}
>  for a more detailed list of properties and methods.
> 

Reply via email to