Version 0.0.5

README.md

@@ -2,7 +2,32 @@
 
 An API Documentation generator.
 
+* **Code sample generation** - Automatic code samples for Python, Javascript, and the command line.
+* **Schema support** - Currently supports [Swagger][swagger], [RAML][raml], and [JSON HyperSchema][jsonhyperschema].
+* **Themes** - Currently includes the [Slate][slate] API documentation theme.
+    Additional themes and support for theme customization is planned.
+
+## Swagger example
+
+The following will build API documentation for the Swagger "PetStore" example API.
 
     $ pip install coredocs
     $ pip install openapi-codec
     $ coredocs build http://petstore.swagger.io/v2/swagger.json --format openapi
+
+![Swagger Screenshot](screenshots/swagger.png)
+
+## RAML example
+
+The following will build API documentation for the Spotify API, based on their RAML schema.
+
+    $ pip install coredocs
+    $ pip install raml-codec
+    $ coredocs build https://raw.githubusercontent.com/spotify/web-api/master/specifications/raml/api.raml --format raml
+
+![RAML Screenshot](screenshots/raml.png)
+
+[swagger]: http://swagger.io/
+[raml]: http://raml.org/
+[jsonhyperschema]: http://json-schema.org/latest/json-schema-hypermedia.html
+[slate]: https://github.com/lord/slate

coredocs/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.4'
+__version__ = '0.0.5'

coredocs/templates/coredocs/document.html

@@ -5,3 +5,7 @@ <h1 id="document-title">{{ document.title }}</h1>
 {% for section_key, section in get_sections(document) %}
 {% include "coredocs/section.html" %}
 {% endfor %}
+
+{% for link_key, link in get_links(document) %}
+{% include "coredocs/link.html" %}
+{% endfor %}

coredocs/templates/coredocs/languages/javascript.html

@@ -8,7 +8,7 @@
 })
 
 // Interact with the API endpoint
-var action = ["{{ section_key }}", "{{ link_key }}"]
+var action = [{% if section_key %}"{{ section_key }}", {% endif %}"{{ link_key }}"]
 {% if link.fields %}var params = {
 {% for field in link.fields %}    {{ field.name }}: ...{% if not loop.last %},{% endif %}
 {% endfor %}}

coredocs/templates/coredocs/languages/python.html

@@ -5,7 +5,7 @@
 document = client.get("{{ schema_url }}"{% if schema_format %}, format="{{ schema_format }}"{% endif %})
 
 # Interact with the API endpoint
-action = ["{{ section_key }}", "{{ link_key }}"]
+action = [{% if section_key %}"{{ section_key }}", {% endif %}"{{ link_key }}"]
 {% if link.fields %}params = {
 {% for field in link.fields %}    "{{ field.name }}": ...{% if not loop.last %},{% endif %}
 {% endfor %}}

coredocs/templates/coredocs/languages/shell.html

@@ -2,4 +2,4 @@
 $ coreapi get {{ schema_url }}{% if schema_format %} --format {{ schema_format }}{% endif %}
 
 # Interact with the API endpoint
-$ coreapi action {{ section_key }} {{ link_key }}{% for field in link.fields %} -p {{ field.name }}=...{% endfor %}{% endhighlight %}</code></pre>
+$ coreapi action {% if section_key %}{{ section_key }} {% endif %}{{ link_key }}{% for field in link.fields %} -p {{ field.name }}=...{% endfor %}{% endhighlight %}</code></pre>

coredocs/templates/coredocs/link.html

@@ -20,7 +20,7 @@ <h3>Path Parameters</h3>
         </thead>
         <tbody>
             {% for field in get_fields('path', link ) %}
-            <tr><td><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
+            <tr><td class="parameter-name"><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
             {% endfor %}
         </tbody>
     </table>
@@ -34,7 +34,7 @@ <h3>Query Parameters</h3>
         </thead>
         <tbody>
             {% for field in get_fields('query', link ) %}
-            <tr><td><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
+            <tr><td class="parameter-name"><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
             {% endfor %}
         </tbody>
     </table>
@@ -48,7 +48,7 @@ <h3>Header Parameters</h3>
         </thead>
         <tbody>
             {% for field in get_fields('header', link ) %}
-            <tr><td><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
+            <tr><td class="parameter-name"><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
             {% endfor %}
         </tbody>
     </table>
@@ -62,7 +62,7 @@ <h3>Request Body</h3>
         </thead>
         <tbody>
             {% for field in get_fields('body', link ) %}
-            <tr><td><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
+            <tr><td class="parameter-name"><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
             {% endfor %}
         </tbody>
     </table>
@@ -75,7 +75,7 @@ <h3>Request Body</h3>
         </thead>
         <tbody>
             {% for field in get_fields('form', link ) %}
-            <tr><td><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
+            <tr><td class="parameter-name"><code>{{ field.name }}</code>{% if field.required %} <strong>required</strong>{% endif %}</td><td>{% if field.description %}{{ field.description }}{% endif %}</td></tr>
             {% endfor %}
         </tbody>
     </table>

coredocs/templates/slate/index.html

@@ -11,6 +11,7 @@
     <style>
         table.parameters strong {color: orange}
         table.parameters code {background-color: transparent}
+        td.parameter-name {white-space: nowrap}
     </style>
     <style>{{ code_style }}</style>
   </head>