Sphinx documentation editor¶

Editing a document¶

The pencil icon loads the "CodeMirror editor" (http://codemirror.net/).

This editor lets you quickly update the corresponding chapter, or then any file within your Sphinx project, and recompile the documentation if you click on toolbar icon "save and close":

Keyboard shorcuts:

• Ctrl+S / Cmd+S : saves the document
• Shift+Ctrl+S / Shift+Cmd+S : saves and closes the document (thus recompiles the documentation)
• Esc / Alt+W / Ctrl+W : closes the document

Further features:

The project tree lets you:

• Move files and pictures by drag and drop
• Rename, create and remove files and directories by right clicking on their name and using the context menu

Cross-linking¶

On the right side, a panel provides a browser of references within your documentation. The references are grouped by chapter using a accordion widget:

At the beginning an input box lets you show the references of any other extension or official manual providing a reStructuredText/Sphinx-based documentation. Just type an extension key, part of the extension title or some words from its description and selects it using the autocompletion mechanism.

Once you have found the reference you are interested in, using it is just a matter of clicking on its name to insert it using the proper reStructuredText syntax in your document:

In case the reference you insert is not coming from your documentation (that is, you are referencing another chapter or section) but is a cross-reference to another document, the Intersphinx mapping of your configuration file Settings.yml will be automatically updated in order for the rendering to succeed. You may want to read section Cross-link to other documentation for additional information.