mkdocs-ringcentral-api-index 0.1.5

An MkDocs plugin to generate a table of contents page for a swagger specification to make navgating to an API Reference easier.

mkdocs-ringcentral-api-index

A MkDocs plugin created by RingCentral to assist in the creation of an API Quick Reference based upon a swagger specification.

At RingCentral we had the desire to publish an API Quick Reference that would make it easier for developers to scan for the endpoint they are looking for and quickly access the documentation for that endpoint in our API Reference.

Setup

Install the plugin using pip:

pip install mkdocs-ringcentral-api-index-plugin

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - rc-api-index:
      spec_url: true
      outfile: 'docs/api-index.md'

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

Options

• spec_url: Sets the URL to the Swagger specification for the RingCentral platform. This should default to the official URL. Override this for development purposes only.
• outfile: The file to output. This file is typically somewhere in your docs folder.

More information about plugins in the MkDocs documentation.

See Also

More information about templates here.

More information about blocks here.