Documentation

Documentation Engine Demo
Tiles are not the only custom item we have
- Dynamic values have a dedicated UI item
- We also have tutorial step
  - Like tiles these will auto join up if in sequence
    - readFile
  - Another step to our tutorial

Documentation Engine Demo¶

This is a demo of how our documentation engine to see the real Paw docs go to Paw Docs

Paw Docs Engine demo

A Tile Component

We can put some txt here... But really we can put any content we want.

A list¶

These items
are normal
Used to link to other doc pages

But we could also put anythign inside here.

function evaluate(context){
    return 1 // a code snippet
};

Another tile

We auto group tiles in react at render time. So that if these tiles are in sequence they will end up in a parent container.

We really can use any markup inside these items it just renders the children.

For example and image banner.

Tiles are not the only custom item we have¶

Dynamic values have a dedicated UI item

Dynamic values have a dedicated UI item¶

../../_images/HTTPBasicAuthDynamicValue.png

Not all custom directives need a dedicated react component, for example this dvvis is a subclass of our tab component. For React this means we have no custom code for dvvis the only custom code is on the sphinx gen side.

The Code Tab however has a lot of dedicated layout info, the data defined here is passed to the AST as config.

com.luckymarmot.BasicAuthDynamicValue

Argument: username: DynamicString: None
The username.

Argument: password: DynamicString: None
The password.

Argument: charset: string: ``utf-8``

The charset used for encoding.

utf-8

function evaluate(context){
    var dv = new DynamicValue('com.luckymarmot.BasicAuthDynamicValue', {
        username: 'john.appleseed',
        password: 'myOwnSuperSecretPassword'
    });
    return dv.getEvaluatedString();
};

Since the dv is just a subclass of of a tabbed view.

We also have tutorial step¶

Like tiles these will auto join up if in sequence

Like tiles these will auto join up if in sequence¶

By auto joining sequence tstep components we are able to dynamically inject step numbers.

As with tiles we can put anything in here.

readFile

readFile¶

Argument: filename: string: None
relative path to file

Returns: None: string
files data read as a string

It may be handy to store files in your Extension directory, and then read their content from your script (e.g. for templates). Use the readFile() function for that purpose.

Another step to our tutorial

Another step to our tutorial¶

Not shown here but our docs can also auto get a list of items on the page and a see also list shown on the right hand side.