Permalink
Browse files

Converted the Configuration page to Sphinx. $!confobj("module.name")!…

…$ sections

still need to be added to the Sphinx docs.

--HG--
branch : experimental
  • Loading branch information...
1 parent c32536b commit 62ec39dc9a21e0659c7516aa66d080124090fd2e @anshumanb anshumanb committed Jan 2, 2012
View
@@ -1,45 +0,0 @@
-
-Qtile is configured in Python. A script (~/.config/qtile/config.py by default) is
-evaluated, and a small set of configuration variables are pulled from its
-global namespace.
-
-# Variables
-
-## @!linkTo("groups.html")!@
-
-A list of __libqtile.manager.Group__ objects which defines the group names.
-
-## @!linkTo("keys.html")!@
-
-A list of __libqtile.manager.Key__ objects which defines the keybindings. At a
-minimum, this will probably include bindings to switch between windows, groups
-and layouts.
-
-## @!linkTo("layouts.html")!@
-
-A list layout objects, configuring the layouts you want to use.
-
-## __main__
-
-A function that executes after the window manager is initialized, but before
-groups, screens and other components are set up. There are few reasons to use
-this, other than testing and debugging.
-
-
-## @!linkTo("mouse.html")!@
-
-A list of __libqtile.manager.Drag__ and __libqtile.manager.Click__ objects
-defining mouse operations.
-
-
-## @!linkTo("screens.html")!@
-
-A list of __libqtile.manager.Screen__ objects, which defines the physical
-screens you want to use, and the bars and widgets associated with them. Most of
-the visible "look and feel" configuration will happen in this section.
-
-
-# Complete example
-
-$!examples.py("examples/config/cortesi-config.py")!$
-
@@ -1,18 +0,0 @@
-
-The __groups__ config file variable should be initialized to a list of Group
-objects.
-
-$!confobj("libqtile.manager.Group")!$
-
-
-# Example
-
-<!--(block | pySyntax)-->
-from libqtile.manager import Group
-groups = [
- Group("a"),
- Group("b"),
- Group("c"),
-]
-<!--(end)-->
-
@@ -1,22 +0,0 @@
-
-Qtile has an extensive set of hooks that users can bind functions to. Be
-careful when writing hooks - they run in the context of the Qtile process, and
-have complete access to all of Qtile's internal object APIs. This means they
-can be arbitrarily powerful, but they can also crash Qtile or corrupt its data
-structures.
-
-Normally, hooks are subscribed to in the Qtile configuration file. Hooks are
-exposed on the __hook.subscribe__ object. The following code will print the
-client name to stderr (which will show up in your .xsession-errors file)
-whenever focus changes.
-
-<!--(block | pySyntax)-->
-from libqtile import hook
-
-def mymethod(c):
- print >> sys.stderr, c.name
-
-hook.subscribe.client_focus(mymethod)
-<!--(end)-->
-
-$!hookobj("libqtile.hook.Subscribe")!$
@@ -1,38 +0,0 @@
-
-The __keys__ variable defines Qtile's key bindings.
-
-
-$!confobj("libqtile.manager.Key")!$
-
-
-# The command.lazy object
-
-__command.lazy__ is a special helper object to specify a command for later
-execution. This object acts like the root of the object graph, which means that
-we can specify a key binding command with the same syntax used to call the
-command through a script or through [qsh](@!urlTo("qsh.html")!@).
-
-
-# Example
-
-<!--(block | pySyntax)-->
-from libqtile.manager import Key
-keys = [
- Key(
- ["mod1"], "k",
- command.lazy.layout.down()
- ),
- Key(
- ["mod1"], "j",
- lazy.layout.up()
- )
-]
-<!--(end)-->
-
-On my system __mod1__ is the Alt key - you can see which modifiers map to which
-keys on your system by running the __xmodmap__ command. This example binds
-__Alt-k__ to the "down" command on the current layout. This command is standard
-on all the included layouts, and switches to the next window (where "next" is
-defined differently in different layouts). The matching "up" command switches
-to the previous window.
-
@@ -1,31 +0,0 @@
-
-A layout is an algorithm for laying out windows in a group on your screen.
-Since Qtile is a tiling window manager, this usually means that we try to use
-space as efficiently as possible, and give the user ample commands that can be
-bound to keys to interact with layouts.
-
-The __layouts__ variable defines the list of layouts you will use with Qtile.
-The first layout in the list is the default. If you define more than one
-layout, you will probably also want to define key bindings to let you switch to
-the next and previous layouts.
-
-# Built-in layouts
-
-$!confobj("libqtile.layout.Max")!$
-
-$!confobj("libqtile.layout.Stack")!$
-
-$!confobj("libqtile.layout.Tile")!$
-
-
-# Example
-
-
-<!--(block | pySyntax)-->
-from libqtile import layout
-layouts = [
- layout.Max(),
- layout.Stack(stacks=2)
-]
-<!--(end)-->
-
@@ -1,22 +0,0 @@
-
-The __mouse__ config file variable defines a set of global mouse actions, and
-is a list of __Click__ and __Drag__ objects..
-
-$!confobj("libqtile.manager.Click")!$
-
-$!confobj("libqtile.manager.Drag")!$
-
-
-# Example
-
-<!--(block | pySyntax)-->
-from libqtile.manager import Click, Drag
-mouse = [
- Drag([mod], "Button1", lazy.window.set_position_floating(),
- start=lazy.window.get_position()),
- Drag([mod], "Button3", lazy.window.set_size_floating(),
- start=lazy.window.get_size()),
- Click([mod], "Button2", lazy.window.bring_to_front())
-]
-<!--(end)-->
-
@@ -1,75 +0,0 @@
-
-The __screens__ configuration variable is where the physical screens, their
-associated __bars__, and the __widgets__ contained within the bars are defined.
-
-
-# screens
-
-$!confobj("libqtile.manager.Screen")!$
-
-# bars
-
-$!confobj("libqtile.bar.Bar")!$
-
-$!confobj("libqtile.bar.Gap")!$
-
-
-# widgets
-
-$!confobj("libqtile.widget.Clock", "clock.png")!$
-
-$!confobj("libqtile.widget.GroupBox", "groupbox.png")!$
-
-$!confobj("libqtile.widget.AGroupBox")!$
-
-$!confobj("libqtile.widget.Prompt")!$
-
-$!confobj("libqtile.widget.Sep")!$
-
-$!confobj("libqtile.widget.Spacer")!$
-
-$!confobj("libqtile.widget.Systray", "systray.png")!$
-
-$!confobj("libqtile.widget.TextBox")!$
-
-$!confobj("libqtile.widget.WindowName")!$
-
-## Graphs
-
-<img src="@!urlTo('graph.png')!@"/>
-
-$!confobj("libqtile.widget.CPUGraph")!$
-
-$!confobj("libqtile.widget.MemoryGraph")!$
-
-$!confobj("libqtile.widget.SwapGraph")!$
-
-
-# Example
-
-Tying together screens, bars and widgets, we get something like this:
-
-<!--(block|pySyntax)-->
-from libqtile.manager import Screen
-from libqtile import bar, widget
-screens = [
- Screen(
- bottom = bar.Bar(
- [
- widget.GroupBox(),
- widget.WindowName()
- ],
- 30,
- ),
- ),
- Screen(
- bottom = bar.Bar(
- [
- widget.GroupBox(),
- widget.WindowName()
- ],
- 30,
- ),
- )
-]
-<!--(end)-->
Oops, something went wrong.

0 comments on commit 62ec39d

Please sign in to comment.