Receipe Book Documentation - Read the Docs

Receipe Book Documentation

Release 0.1 i Rashadul

July 01, 2014

Contents

1 Contents

1

1.1 Convention used in the document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.2 Exclusive soup in few minutes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.3 Exclusive salad in few minutes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

2 License

17

3 Indices and tables

19

i

ii

CHAPTER 1

Contents

1.1 Convention used in the document

1.1.1 Sphinx quickstart

To get started, cd into the documentation directory and type: $ sphinx-quickstart

Please enter values for the following settings (just press Enter to accept a default value, if one is given in brackets).

Here is a list of the default used in this project:

Prompt > Root path for the documentation [.]: > Separate source and build directories (y/N) [n]: > Name prefix for templates and static dir [_]: > Project name: > Author name(s): > Project version: > Project release [0.0.1]: > Source file suffix [.rst]: > Name of your master document (without suffix) [index]: > autodoc: automatically insert docstrings from modules (y/N) [n]: > doctest: automatically test code snippets in doctest blocks (y/N) [n]: > intersphinx: link between Sphinx documentation of different projects (y/N) [n]: > todo: write "todo" entries that can be shown or hidden on build (y/N) [n]: > coverage: checks for documentation coverage (y/N) [n]: > pngmath: include math, rendered as PNG images (y/N) [n]: > jsmath: include math, rendered in the browser by JSMath (y/N) [n]: > ifconfig: conditional inclusion of content based on config values (y/N) [n]: > Create Makefile? (Y/n) [y]: > Create Windows command file? (Y/n) [y]:

Choice y an_example_pypi_project Andrew Carter 0.0.1 y n y n n n n y n n

Then you should get:

Finished: An initial directory structure has been created.

You should now populate your master file .\source\index.rst and create other documentation

1

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download