Skip to content

beeware/galley

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

image

Galley

image

image

image

image

Build Status

Discord server

GUI tool to assist in drafting documentation.

Quickstart

In your virtualenv, install Galley, and then run it:

$ pip install galley
$ galley

This will pop up a GUI window.

Problems under Ubuntu

Ubuntu's packaging of Python omits the idlelib library from it's base packge. If you're using Python 2.7 on Ubuntu 13.04, you can install idlelib by running:

$ sudo apt-get install idle-python2.7

For other versions of Python and Ubuntu, you'll need to adjust this as appropriate.

Problems under Windows

If you're running Galley in a virtualenv, you'll need to set an environment variable so that Galley can find the TCL graphics library:

$ set TCL_LIBRARY=c:\Python27\tcl\tcl8.5

You'll need to adjust the exact path to reflect your local Python install. You may find it helpful to put this line in the activate.bat script for your virtual environment so that it is automatically set whenever the virtualenv is activated.

Documentation

Documentation for Galley can be found on Read The Docs.

Community

Galley is part of the BeeWare suite. You can talk to the community through:

We foster a welcoming and respectful community as described in our BeeWare Community Code of Conduct.

Contributing

If you experience problems with Galley, log them on GitHub. If you want to contribute code, please fork the code and submit a pull request.

About

A GUI tool for reviewing ReST/Sphinx documentation

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages