https://github.com/jalcine/sphinx-build-qt

A simple PyQt GUI for sphinx-build
https://github.com/jalcine/sphinx-build-qt

Last synced: 28 days ago
JSON representation

A simple PyQt GUI for sphinx-build

• Host: GitHub
• URL: https://github.com/jalcine/sphinx-build-qt
• Owner: jalcine
• Created: 2014-05-16T20:46:16.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2012-02-29T21:13:49.000Z (almost 13 years ago)
• Last Synced: 2024-10-14T09:55:25.234Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 273 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
About

=====

**sphinx-build-qt** is a simple 

`PyQt `_ GUI for 

the ``sphinx-build`` program from the 

`Python Sphinx `_ project. Version ``0.2`` can 

build an entire project or individual files. 

.. image:: https://github.com/vkvn/sphinx-build-qt/raw/master/images/screenshot-0.2.png 

Requirements

------------

Users

.....

* Python Sphinx

* PyQt4

Developers

..........

To follow this tutorial you will need

* Qt Designer

* PyQt4 including the development tools (for pyuic4)

* Python Sphinx

.. note::

    

    The tutorial delivered at PyCon Ireland 2011 can be found in the **pycon** 

    branch.

For Ubuntu and derivatives

...........................

Use Synaptic package manager or ``sudo apt-get install packagename``

* qt4-designer

* python-qt4 

* pyqt4-dev-tools

* python-sphinx

For Windows

...........

The PyQt4 package from Riverbank computing contains Qt Designer 

and the required scripts

http://www.riverbankcomputing.co.uk/software/pyqt/download

You can use easy_install or pip to install python-sphinx

For Mac

.......

Sorry, I have no idea how you can get all these installed.

You wouldn't need to add anything to PATH I believe as they should be there

by default (/usr/bin or /usr/local/bin)

Files

-----

* src/sphinx-build-qt.py - main application

* src/ui_dialog.py - Python code of dialog.ui generated using pyuic4

* ui/dialog.ui - the dialog interface designed using Qt Designer (XML format)

The ``docs`` directory contains an example sphinx project

The ``source`` directory is used as source in the dialog and ``build\html`` is

used for the output.