diff --git a/.gitignore b/.gitignore index 52453958f..874dec434 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,9 @@ .bundle .jekyll-metadata +_data/api/* +_data/nav_api.yml _site _config-prod.yml _config-local.yml -docs +api/* vendor diff --git a/_data/api/.gitkeep b/_data/api/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/_includes/namespace.html b/_includes/namespace.html new file mode 100644 index 000000000..986c1a905 --- /dev/null +++ b/_includes/namespace.html @@ -0,0 +1,47 @@ +{% if include.data.borrows.size %} +## Extends +{% for item in include.data.borrows %} +[{{ item }}]({{ site.baseurl }}/api/class/{{ item | api_url }}) +{% endfor %} +{% endif %} + +{% if include.data.properties.size > 0 %} +## Properties +link | summary +--- | --- +{% for item in include.data.properties %}[{{ item.name }}]({{ site.baseurl }}/api/{{ item.dataTypes[0] | api_url }}) | {{ item.summary | no_nl }} +{% endfor %} +{% endif %} + +{% if include.data.methods.size > 0 %} +## Methods +{% for item in include.data.methods %} + +### {{ item.name }} +{{ item.summary | no_nl }} + +#### Signature +`{{ item.signature }}` + +{% if item.params.size > 0 %} +#### Parameters + +Name | Type | Description +--- | --- | --- +{% for param in item.params %}{{ param.name }} | {{ param.types }} | {{ param.desc | no_nl }} +{% endfor %} +{% endif %} + +#### Return type +{% for type in item.return.types %}[{{ type }}]({{ site.baseurl}}/api/class/{{ type | api_url }}), {% endfor %}: {{ item.return.desc }} + +{% endfor %} +{% endif %} + +{% if include.data.events.size > 0 %} +## Events +link | summary +--- | --- +{% for item in include.data.events %}[{{ item.name }}]({{ site.baseurl }}/api/{{ item.dataTypes[0] | api_url }}) | {{ item.summary | no_nl }} +{% endfor %} +{% endif %} diff --git a/_includes/nav.html b/_includes/nav.html index 5e7cf78f3..cfcdd6461 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -1,6 +1,7 @@