ANN: Sydebar 1.0 - A browser sidebar generator for Python documentation

Remy Blank remy.blank at pobox.com
Tue Jun 3 23:49:01 CEST 2008


Content-Type: text/plain; charset=UTF-8; format=flowed

Content-Transfer-Encoding: quoted-printable



I am pleased to announce the first release of Sydebar, a browser sidebar =



generator for Python documentation. For the impatient, sample outputs=20

for all Python versions ever released can be found here:



   http://c-space.org/download/Sydebar/samples/



The program generates a single, self-contained XHTML file for a specific =



Python documentation URL, which can be local or remote. The generated=20

file is loaded into the sidebar of some popular browsers (tested on=20

Firefox and Opera, Mozilla should work as well), and presents a tabbed=20

interface with one page for each of the following documentation sections:=





  * Tutorial

  * Language reference

  * Library reference

  * Python/C API

  * Extending and embedding

  * Global module index



Each page shows a collapsible tree of chapters, with links opening the=20

corresponding section in the main browser pane. The global module index=20

features an incremental search functionality with fast keyboard navigatio=

n.



Moreover, a search page allows performing searches on various subsets of =



python.org (specific parts of the website, PEPs, newsgroups, PyPI and=20

the issue tracker).



The documentation and PyPI entry can be found here:



   http://c-space.org/software/Sydebar.html

   http://pypi.python.org/pypi/Sydebar



I would like to mention that Sydebar was inspired by python-sidebar from =



Daniel Lundin at Edgewall Software, and even though I didn't borrow any=20

code from there, the layout does bear quite some resemblance.



Feedback is very welcome.



Thanks for reading!

-- Remy




-------------- next part --------------
Content-Type: application/pgp-signature; name="signature.asc"

Content-Description: OpenPGP digital signature

Content-Disposition: attachment; filename="signature.asc"



-----BEGIN PGP SIGNATURE-----

Version: GnuPG v2.0.9 (GNU/Linux)



iEYEARECAAYFAkhFvFEACgkQCeNfIyhvXjISEACgmUXSorHaZ7JjNC2AqTuJtWod

BAgAn3g/97+9cI9m5n2QBpvcmtxQnGB0

=IQ6Q

-----END PGP SIGNATURE-----




More information about the Python-list mailing list