https://github.com/beeware/galley

A GUI tool for reviewing ReST/Sphinx documentation
https://github.com/beeware/galley

Last synced: 3 months ago
JSON representation

A GUI tool for reviewing ReST/Sphinx documentation

• Host: GitHub
• URL: https://github.com/beeware/galley
• Owner: beeware
• License: bsd-3-clause
• Created: 2015-01-21T23:53:41.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2023-01-16T03:20:32.000Z (about 2 years ago)
• Last Synced: 2024-03-26T14:11:48.538Z (10 months ago)
• Language: Python
• Size: 47.9 KB
• Stars: 25
• Watchers: 9
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://beeware.org/project/projects/tools/galley/galley.png

    :width: 72px

    :target: https://beeware.org/galley

Galley

======

.. image:: https://img.shields.io/pypi/pyversions/galley.svg

    :target: https://pypi.python.org/pypi/galley

.. image:: https://img.shields.io/pypi/v/galley.svg

    :target: https://pypi.python.org/pypi/galley

.. image:: https://img.shields.io/pypi/status/galley.svg

    :target: https://pypi.python.org/pypi/galley

.. image:: https://img.shields.io/pypi/l/galley.svg

    :target: https://github.com/pybee/galley/blob/main/LICENSE

.. image:: https://github.com/beeware/galley/workflows/CI/badge.svg?branch=main

   :target: https://github.com/beeware/galley/actions

   :alt: Build Status

.. image:: https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic

   :target: https://beeware.org/bee/chat/

   :alt: 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:

* `@pybeeware on Twitter`_

* `Discord `__

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`_.

.. _BeeWare suite: https://beeware.org

.. _Read The Docs: https://galley.readthedocs.io

.. _@pybeeware on Twitter: https://twitter.com/pybeeware

.. _BeeWare Community Code of Conduct: https://beeware.org/community/behavior/

.. _log them on Github: https://github.com/beeware/galley/issues

.. _fork the code: https://github.com/beeware/galley

.. _submit a pull request: https://github.com/beeware/galley/pulls