Skip to content

Commit

Permalink
Docs api reference first iteration of styling (hyperledger-archives#2433
Browse files Browse the repository at this point in the history
)

* nunjucks changes, typographic changes

Signed-off-by: samwinslet <samwinslet@uk.ibm.com>

* updates to table styling on docs site

Signed-off-by: samwinslet <samwinslet@uk.ibm.com>
  • Loading branch information
winslet authored and bestbeforetoday committed Oct 20, 2017
1 parent 7a882b3 commit e2c8b8f
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 10 deletions.
20 changes: 11 additions & 9 deletions packages/composer-website/apigen-opus/_template/class.njk
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: {{name}} ({{module | capitalize }} API)
section: api
sidebar: sidebars/accordion-toc0.md
excerpt: The Client, Admin, and Runtime components of Hyperledger Composer .
excerpt: The Client, Admin, and Runtime components of Hyperledger Composer
index-order: {{index}}
---
# {{name}}
Expand All @@ -14,23 +14,25 @@ index-order: {{index}}
- **Extends** {{extends}}
- **Module** {{module}}

### See also
{% for sa in seeAlso -%}
### See also
- {{sa}}
{% else %}

{% endfor %}

## Method Summary
| Returns | Name | Description |
| :-------- | :---- | :----------- |
{% for method in methods | sort(attribute='name') %}| `{{method.returnType}}` | [{{method.name}}](#{{method.name | lower }}{% for args in method.methodArgs %}-{{args | lower }}{% endfor %}) | {{method.description[0]}} |
| Name | Returns | Description |
| :---- | :-------- | :----------- |
{% for method in methods | sort(attribute='name') %}| [{{method.name}}](#{{method.name | lower }}{% for args in method.methodArgs %}-{{args | lower }}{% endfor %}) | `{{method.returnType}}` | {{method.description[0]}} |
{% endfor %}

## Method Details
# Method Details
{% for method in methods %}
{% if method.name == 'constructor'%}
## new {{name}}()
## new {{name}}()
{% else %}
## {{method.name}}({% for args in method.methodArgs %}{{args | lower }}{% if not loop.last %},{% endif %}{% endfor %})
## {{method.name}}({% for args in method.methodArgs %}{{args | lower }}{% if not loop.last %},{% endif %}{% endfor %})
{% endif %}


Expand Down Expand Up @@ -67,4 +69,4 @@ index-order: {{index}}

No parameters
{% endif %}
{% endfor %}
{% endfor %}
Loading

0 comments on commit e2c8b8f

Please sign in to comment.