Sydebar 1.0

Sydebar is a browser sidebar generator for Python documentation.
Sydebar is a browser sidebar generator for Python documentation.

Sydebar is a browser sidebar generator for Python documentation pages. It can generate Python documentation sidebars for all Python versions, with the documentation pages either local or on a remote web server.

Sydebar parses the documentation index of a specific version of Python, and generates a single, self-contained XHTML document with one panel per section for the following sections:

Tutorial
Language reference
Library reference
Python/C API
Extending and embedding
Global module index

Additionally, a search panel allows performing searches on the following sources:

Various subsets of python.org, including the mailing list archives
The Python Enhancement Proposals (PEPs)
The comp.lang.python.* newsgroups
The Python Package Index
The Python issue tracker

Sydebar is released under the GNU General Public License version 2.

Requirements:

Python

Installation:

Sydebar requires Python 2.4 or later and probably runs on all platforms where Python runs. It has been tested on Linux and Windows. The latest version can be downloaded at this location. Installation is not really necessary, as the sydebar.py script in the bin folder can be run directly from an unpacked source archive. A system-wide installation can be performed anyway with the usual distutils command:

python setup.py install

Usage:

Sydebar generates XHTML sidebars for specific versions of the Python documentation. The generated page must be bookmarked in the browser and set up to be displayed in the sidebar instead of the main browser pane.
Generating the sidebar document

This step takes a URL pointing to the index page of the documentation for a specific Python version and a few options as inputs, and outputs a self-contained XHTML file containing the sidebar data and code. It only has to be performed once per documentation URL.

Command line usage information for the program can be displayed with sydebar.py --help:

$ sydebar.py --help
Usage: sydebar.py [options]

Sydebar 1.0 A browser sidebar generator for Python documentation
Copyright (C) 2008 Remy Blank

Sydebar is a browser sidebar generator for Python documentation pages. It can
generate Python documentation sidebars for all Python versions. The
documentation pages can be either local or on a remote web server.

Options:
--debug Show a full traceback when exceptions are raised
during execution.
-h, --help Show this help message and exit.
--version Show the program version and exit.

Input options:
--image-clear=FILE Read the 'clear' image from FILE. The default is
'clear.png'.
--image-icon=FILE Read the 'icon' image from FILE. The default is
'python.ico'.
--image-minus=FILE Read the 'minus' image from FILE. The default is
'minus.png'.
--image-plus=FILE Read the 'plus' image from FILE. The default is
'plus.png'.
--image-search=FILE
Read the 'search' image from FILE. The default is
'search.png'.
-t FILE, --template=FILE
Read the page template from FILE. The default is
'template.html'.
-u URL, --url=URL Generate the sidebar for the Python documentation
located at URL. The default is
'http://www.python.org/doc/2.4.4/'.

Output options:
-a, --all-versions Generate sidebars for all documentation versions
available on python.org. The output file name must
contain a '%s' pattern that will be replaced by the
version string.
-f N, --field-width=N
Set the width of text fields to N characters. The
default is 25.
-n, --no-pack Don't pack the resulting XHTML file (i.e. don't remove
non-significant white space). This will output nicely
indented and readable XHTML.
-o FILE, --output=FILE
Write the output to FILE. If FILE is '-', the output
is written to standard output. The default is '-'.
-p PANEL, --panel=PANEL
Show PANEL when loading the sidebar. PANEL can be one
of Tut, Ref, Lib, Api, Ext, Mod, Search. The default
is to show the module index if it is available, and
the tutorial otherwise.
-s N, --font-size=N
Set the base font size to N pixels. The default is 11.

last updated on:
July 31st, 2008, 10:31 GMT
price:
FREE!
homepage:
c-space.org
license type:
GPL (GNU General Public License) 
developed by:
Remy Blank
category:
ROOT \ Documentation
Sydebar
Download Button

In a hurry? Add it to your Download Basket!

user rating 7

3.3/5
 

0/5

Rate it!

Add your review!

SUBMIT