This repository hosts the new developer documentation for Mautic on the Read the Docs platform. Whenever a PR is merged, changes are deployed immediately to https://mautic-developer.readthedocs.io/

If you're looking for our legacy developer documentation, please go to https://developer.mautic.org/ or the GitHub repository.

We aim to move all aspects of the developer documentation to Read the Docs (with the exception of the REST API documentation). In the video below, @dennisameling explains how the documentation is currently structured and briefly touches upon current limitations we're running into.

For more background, our end goal, and to let us know if you want to help, please check out this issue. Thanks in advance!

• RST Syntax Cheatsheet
• Sphinx Demo
• Sphinx Syntax

The following provides instructions for how to build docs locally for visualization without pushing to the remote:

1. Install Python 3 for your OS if not already installed
2. Install Sphinx pip install sphinx
3. Install sphinx-rtd-theme pip install sphinx-rtd-theme
4. CD into the docs directory cd [path to this repo]/docs
5. Run make html
6. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser.

Before pushing, run Vale and address suggestions and errors as applicable.

1. Install vale
2. vale .

You can automatically build changes to rst files using a file watcher.

1. Go to Preferences -> Tools -> File Watchers -> + button -> custom
2. Configure the watcher as presented in the screenshot