~ellisonbg/ipython/bugfixes0411409

« back to all changes in this revision

Viewing changes to doc/build_doc_instruction.txt

• browse files at revision 0.1.1
• compare with another revision
• download diff
• download tarball
• view history from revision 0.1.1

Show diffs side-by-side

added

removed

doc/build_doc_instruction.txt

 

1

How to generate IPython documentation

 

2

=====================================

 

3

 

 

4

The doc is written using lyx http://www.lyx.org, which is a gui for latex

 

5

documents. LyX also requires a latex installation.

 

6

 

 

7

The file manual_base.lyx is the template file that should be edited if you

 

8

want to do changes to the docs.

 

9

 

 

10

A final version is generated by running 

 

11

 

 

12

./update_manual.py

 

13

 

 

14

or 

 

15

 

 

16

ipython update_manual.py

 

17

 

 

18

(note that "python update_manual.py" won't work, it's an ipython script!)

 

19

 

 

20

The script update_manual.py will insert the current version number into the

 

21

template and also generate magic.tex, a file containing documentation for

 

22

the doc strings of the magic commands.

 

23

 

 

24

The script creates manual.lyx which can be opened by lyx to generate pdf or

 

25

postscript versions of the docs.

 

26

 

 

27

update_magic.sh and update_version.sh work too, but are slated for

 

28

deprecation.

Loggerhead is a web-based interface for Breezy
Version: 2.0.1