upstream/ipython Files · docs/README.rst

Initial messing around....

Initial messing around. Latex tab completion will have to be done outside the normal completer logic as the completer line splitting logic uses \\ as a special character to split lines on. I probably want to put the latex completions first and it if finds any matches, don't do any other completion logic. The only issue is that might short circuit dir/path matching on windows. Hmmm.

Paul Ivanov - - Load All Authors

File last commit:

r12939:805cbf06


                r17700:7b6d94ef

Download file

             README.rst
        
                    32 lines
            
             | 960 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / README.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Paul Ivanov
    
README now includes description of make targets

              r12939
            
      IPython Documentation

      ---------------------

        fperez
    
Reorganized the directory for ipython/ to have its own dir, which is a bit...

              r0
            
        Paul Ivanov
    
README now includes description of make targets

              r12939
            
      This directory contains the majority of the documentation for IPython. 

      Requirements

      ------------

      The following tools are needed to build the documentation:

      sphinx

      On Debian-based systems, you should be able to run::

          sudo apt-get install sphinx 

      The documentation gets built using ``make``, and comes in several flavors.

      ``make html`` - build the API and narrative documentation web pages, this

      is the the default ``make`` target, so running just ``make`` is equivalent to

      ``make html``. 

      ``make html_noapi`` - same as above, but without running the auto-generated

      API docs. When you are working on the narrative documentation, the most time

      consuming portion  of the build process is the processing and rending of the

      API documentation. This build target skips that.

      ``make pdf`` will compile a pdf from the documentation.

      You can run ``make help`` to see information on all possible make targets.

        fperez
    
Reorganized the directory for ipython/ to have its own dir, which is a bit...

              r0

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Paul Ivanov README now includes description of make targets	r12939	IPython Documentation
		---------------------
fperez Reorganized the directory for ipython/ to have its own dir, which is a bit...	r0
Paul Ivanov README now includes description of make targets	r12939	This directory contains the majority of the documentation for IPython.

		Requirements
		------------
		The following tools are needed to build the documentation:

		sphinx

		On Debian-based systems, you should be able to run::

		sudo apt-get install sphinx

		The documentation gets built using ``make``, and comes in several flavors.

		``make html`` - build the API and narrative documentation web pages, this
		is the the default ``make`` target, so running just ``make`` is equivalent to
		``make html``.

		``make html_noapi`` - same as above, but without running the auto-generated
		API docs. When you are working on the narrative documentation, the most time
		consuming portion of the build process is the processing and rending of the
		API documentation. This build target skips that.

		``make pdf`` will compile a pdf from the documentation.

		You can run ``make help`` to see information on all possible make targets.
fperez Reorganized the directory for ipython/ to have its own dir, which is a bit...	r0