MasterPush provide mobile text message delivery service of large marketing campaign and an api to send message on the go.

https://www.masterpush.com/

This is the repository of the french documentation Masterpush https://www.masterpush.com/. It hosts the reference documentation that will be maintained and augmented regularly with the new features documentation provided on each release of the Masterpush product.

The documentation is intended to be built in a readthedocs reStructuredText environment which means the content are wrote in the reStructuredText format in rst files and that the build take place in a python env with the sphinx documentation tool.

While this documentation is available online at https://docs.masterpush.com/, for contributing purpose, you may want to clone and build it localy. Here are the steps to follow to do it.

First, you need to add the dependencies to build the documentation properly. You have to install sphinx and sphinx-rtd-theme:

$ pip install sphinx sphinx_rtd_theme

Additionally and for convenience, you can install sphinx-autbuild

$ pip install sphinx-autobuild

Then clone the repository on you computer (if you want to contribute, you can fork the project, then clone your fork), go in the directory and launch the build.

$ git clone https://github.com/masterpush/docs.git
$ cd docs
$ make html

You will find your html files in the _build directory.

If you have installed sphinx-autobuild, you can also launch in the same documentation directory:

$ sphinx-autobuild . _build_html

It will build the documentation in the _build_html as soon as you update and save a file. Further more, it will launch an http server (the url is given by the command, generally http://127.0.0.8000) that will reload the content after each build.

We want to constantly improve our documentations and products and your feedbacks are welcome (needed?!) to do it. Please let us know what you think of our work. Thanks!

Feel free to contribute on GitHub.

    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝