upstream/ipython Files · docs/source/development/index.rst

Use Sphinx autosummary extension for API docs index

Thomas Kluyver - - Load All Authors

File last commit:

r13492:dc8ae17d


                r13605:7b7e2f1f

Download file

             index.rst
        
                    28 lines
            
             | 693 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / source / development / index.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Brian Granger
    
Work on documentation....

              r2276
            
      .. _developer_guide:

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

      IPython developer's guide

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

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
        Brian Granger
    
Adding link from Sphinx dev docs to GH wiki Dev: Index.

              r9683
            
      This are two categories of developer focused documentation:

      1. Documentation for developers of *IPython itself*.

      2. Documentation for developers of third party tools and libraries

         that use IPython.

      This part of our documentation only contains information in the second category.

      Developers interested in working on IPython itself should consult

      our `developer information <https://github.com/ipython/ipython/wiki/Dev:-Index>`_ 

      on the IPython GitHub wiki.

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
      .. toctree::

        Brian Granger
    
Major work on the documentation....

              r2277
            
         :maxdepth: 1

        Brian E Granger
    
Beginning to organize the rst documentation.

              r1256
            
        Brian Granger
    
Removing old dev docs.  All of this has been moved to GH wiki.

              r9678
            
        Paul Ivanov
    
update indexes to use .rst, remove .txt refs

              r11730
            
         gitwash/index

         messaging

         parallel_messages

         parallel_connections

        Thomas Kluyver
    
Document single codebase Python 3 compatibility

              r13388
            
         pycompat

        Thomas Kluyver
    
Start separating config docs into user and developer parts

              r13492
            
         config

	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

Brian Granger Work on documentation....	r2276	.. _developer_guide:

		=========================
		IPython developer's guide
		=========================
Brian E Granger Beginning to organize the rst documentation.	r1256
Brian Granger Adding link from Sphinx dev docs to GH wiki Dev: Index.	r9683	This are two categories of developer focused documentation:

		1. Documentation for developers of IPython itself.
		2. Documentation for developers of third party tools and libraries
		that use IPython.

		This part of our documentation only contains information in the second category.

		Developers interested in working on IPython itself should consult
		our `developer information <https://github.com/ipython/ipython/wiki/Dev:-Index>`_
		on the IPython GitHub wiki.

Brian E Granger Beginning to organize the rst documentation.	r1256	.. toctree::
Brian Granger Major work on the documentation....	r2277	:maxdepth: 1
Brian E Granger Beginning to organize the rst documentation.	r1256
Brian Granger Removing old dev docs. All of this has been moved to GH wiki.	r9678
Paul Ivanov update indexes to use .rst, remove .txt refs	r11730	gitwash/index
		messaging
		parallel_messages
		parallel_connections
Thomas Kluyver Document single codebase Python 3 compatibility	r13388	pycompat
Thomas Kluyver Start separating config docs into user and developer parts	r13492	config