Skip to content

mailgun/documentation

master
Switch branches/tags
Code

Mailgun Documentation

This Github repository represents Mailgun's documentation site, located at http://documentation.mailgun.com. The site is based on the Sphinx documentation generator for Python.

To suggest changes to the documentation, please submit an Issue or Pull Request.

reStructuredText

The documentation pages are built using the reStructuredText standard. Github supports RST, so modification via Github's editor is recommended.

Deployment

Documentation is hosted via ReadTheDocs and changes are automatically deployed when code is merged into master. To monitor build statuses and debug failed builds, see the builds page.

Support and Feedback

If you find an issue, please submit the issue in Github directly. Documentation Issues

As always, if you need additional assistance, drop us a note through your Control Panel at https://app.mailgun.com/app/support.

Building Documentation Locally

Install Sphinx and then run the command sphinx-build source build. The built html files can then be found in the build directory.