Sphinx-Preview

Sphinx-Preview allows you to write and preview Sphinx Documentation using Atom.

Sphinx Demo

Installation

Install the Sphinx-Preview Atom package with the following command:

apm install sphinx-preview

Or via the Settings View : Install in Atom.

You also need to install the following dependencies.

Dependencies

This package needs Docker and the browser-plus Atom package. It will use Sphinx-Server to build the documentation.

Docker

Install Docker by reading the official documentation : https://docs.docker.com/engine/installation/

Atom `browser-plus` package

Install the browser-plus package by running the following command:

apm install browser-plus

Usage

Open Atom at the root of your documentation.
Press ctrl-alt-o on a rst file to open the preview

How does it work ?

Sphinx-Preview pulls and runs the Sphinx-Server. It mounts the opened project folder. Finally, the package launches a browser-plus panel on the active rst file.