Create Documentation with RST, Sphinx, Sublime, and GitHub — RST | Sph...

Popular pages

• Use Tables — RST | Sphinx | Sublime | GitHub documentation

  Tables are very useful for presenting complex information. With reStructured Text and Sphinx, you can create tables in several ways. List Table Directive¶ .. list-table:: directive. Each table has th...

• Create Documentation with RST, Sphinx, Sublime, and GitHub — RST | Sphinx | Sublime | GitHub

  Create Documentation with RST, Sphinx, Sublime, and GitHub¶ This project captures guidelines and tips for efficiently creating documentation using RST, Sphinx, Sublime Text, and GitHub. This project i...

• Use Lists — RST | Sphinx | Sublime | GitHub documentation

  * Item 1. * Item 2. * Item 3. An unordered lists should have 3-7 items. Unordered List Inside Ordered List¶ To include an unordered list inside an ordered list, indent the unordered list three spaces...

• Create a Sphinx Project — RST | Sphinx | Sublime | GitHub documentation

  Create a Sphinx Project¶ You can use your fork of the Get Started with Sphinx Repository as the start of a new project, or you can create the project by entering the command: $ sphinx-quickstart Sphi...

• Show Example Code — RST | Sphinx | Sublime | GitHub documentation

  pygments, which show syntax color coding for that code sample. (Ensure that your project conf.py file contains pygments_style = 'sphinx'). If you might use the same example code in multiple parts of...

• Set Up Your System — RST | Sphinx | Sublime | GitHub documentation

  Use PIP to install Sphinx. On the command line, enter: $ pip install Sphinx Note If you are using Windows, this might be a frustrating task. If you get stuck, share the error messages and ask for hel...