Skip to content
This repository has been archived by the owner on Dec 22, 2019. It is now read-only.

Latest commit

 

History

History
56 lines (37 loc) · 1.14 KB

index.rst

File metadata and controls

56 lines (37 loc) · 1.14 KB

Getting Started!

Install Sphinx

At first, install Sphinx.

Since Sphinx is written by Python, you need to install Python and Sphinx. Windows Standalone Installer can install both software at once.

.. toctree::
   :maxdepth: 2

   install_windows
   install_windows_standalone
   install_unix

Create Project

To create document by Sphinx, you need to create the project of the document. Creating project is similar about Scaffold of Ruby on Rails or Django Project, only answer some question.

This chapter describes the document tree structure and accomplish the form.

.. toctree::
   :maxdepth: 2

   make_project

Add tables and lists

You need to use reStructredText format which is similar to Wiki to writing Sphinx document. This chapter introduce useful markups.

.. toctree::
   :maxdepth: 2

   use_markup

Introduce directives

This chapter describes directives which are implemented in reStructuredText.

.. toctree::
   :maxdepth: 2

   directives