Draft Sphinx doc structure
This commit is contained in:
Nguyễn Gia Phong
parent
f452b5780f
commit
b7d08fc84b
|
|
@ -1 +1,2 @@
|
|||
*~
|
||||
build/
|
||||
|
|
|
|||
82
README.md
82
README.md
|
|
@ -16,7 +16,7 @@ description).
|
|||
## Usage
|
||||
|
||||
When provided by an operating system package, or installed from source
|
||||
into the Lua library path Vicious can be used as a regular Lua
|
||||
into the Lua library path Vicious, can be used as a regular Lua
|
||||
library, to be used stand-alone or to feed widgets of any window
|
||||
manager (e.g. Ion, WMII). It is compatible with Lua version 5.1 and above.
|
||||
|
||||
|
|
@ -889,80 +889,14 @@ a compatible license. All contributors retain their copyright to their code,
|
|||
so please make sure you add your name to the header of every file you touch.
|
||||
|
||||
|
||||
## Authors
|
||||
## Copying
|
||||
|
||||
Wicked was written by:
|
||||
Vicious is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as
|
||||
published by the Free Software Foundation, either version 2 of the
|
||||
License, or (at your option) any later version.
|
||||
|
||||
* Lucas de Vries \<lucas glacicle.com\>
|
||||
Please refer to our documentation for the full [list of authors].
|
||||
|
||||
Vicious was originally written by:
|
||||
|
||||
* Adrian C. (anrxc) \<anrxc sysphere.org\>
|
||||
|
||||
Current maintainers:
|
||||
|
||||
* Jörg Thalheim (Mic92) \<joerg thalheim.io\>
|
||||
* [mutlusun](https://github.com/mutlusun) (especially the FreeBSD port)
|
||||
* Daniel Hahler (blueyed) \<github thequod.de\>
|
||||
* Nguyễn Gia Phong (McSinyx) \<vn.mcsinyx gmail.com\>
|
||||
|
||||
Contributors, listed in alphabetic order:
|
||||
|
||||
* 0x5b \<dragen15051 gmail.com\>
|
||||
* Adam Lee \<adam8157 gmail.com\>
|
||||
* Alexander Koch \<lynix47 gmail.com\>
|
||||
* Amir Mohammad Saied \<amirsaied gmail.com\>
|
||||
* Andrea Scarpino \<me andreascarpino.it\>
|
||||
* Andreas Geisenhainer \<psycorama datenhalde.de\>
|
||||
* Andrew Merenbach \<andrew merenbach.com\>
|
||||
* Andrzej Bieniek \<andyhelp gmail.com\>
|
||||
* Arthur Axel 'fREW' Schmidt \<git frew.co\>
|
||||
* Arvydas Sidorenko \<asido4 gmail.com\>
|
||||
* Benedikt Sauer \<filmor gmail.com\>
|
||||
* Beniamin Kalinowski \<beniamin.kalinowski gmail.com\>
|
||||
* Benoît Zugmeyer \<bzugmeyer gmail.com\>
|
||||
* blastmaster \<blastmaster tuxcode.org\>
|
||||
* Brandon Hartshorn \<brandonhartshorn gmail.com\>
|
||||
* crondog \<patches crondog.com\>
|
||||
* David Udelson \<dru5 cornell.edu\>
|
||||
* Dodo The Last \<dodo.the.last gmail.com\>
|
||||
* Elric Milon \<whirm gmx.com\>
|
||||
* Enric Morales \<me enric.me\>
|
||||
* getzze \<getzze gmail.com\>
|
||||
* Greg D. \<jabbas jabbas.pl\>
|
||||
* Hagen Schink \<troja84 googlemail.com\>
|
||||
* Henning Glawe \<glaweh debian.org\>
|
||||
* Hiltjo Posthuma \<hiltjo codemadness.org\>
|
||||
* [James Reed](https://github.com/supplantr)
|
||||
* Jay Kamat \<jaygkamat gmail.com\>
|
||||
* Jeremy \<jeremy.sainvil gmaill.com\>
|
||||
* jinleileiking \<jinleileiking gmail.com\>
|
||||
* joe di castro \<joe joedicastro.com\>
|
||||
* Joerg Jaspert \<joerg debian.org\>
|
||||
* Jonathan McCrohan \<jmccrohan gmail.com\>
|
||||
* [Juan Carlos Menonita](https://github.com/JuanKman94)
|
||||
* Juergen Descher \<jhdl gmx.net\>
|
||||
* Julian Volodia \<julianvolodia gmail.com\>
|
||||
* Keith Hughitt \<keith.hughitt gmail.com\>
|
||||
* Lorenzo Gaggini \<lg lgaggini.net\>
|
||||
* Lyderic Lefever \<lyderic.lefever gmail.com\>
|
||||
* Martin Striz \<striz raynet.cz\>
|
||||
* Martin Ueding \<dev martin-ueding.de\>
|
||||
* Mellich \<mellich gmx.net\>
|
||||
* Michael Kressibucher \<mkressibucher hotmail.com\>
|
||||
* Michael Unterkalmsteiner \<miciu gmx.de\>
|
||||
* niko \<nikomomo gmail.com\>
|
||||
* Noah Tilton \<code tilton.co\>
|
||||
* Normal Ra \<normalrawr gmail.com\>
|
||||
* Perry Hargrave \<perry.hargrave gmail.com\>
|
||||
* Rémy CLOUARD \<shikamaru shikamaru.fr\>
|
||||
* [Roberto](https://github.com/empijei)
|
||||
* Sébastien Luttringer \<seblu seblu.net\>
|
||||
* Shadowmourne G \<s10e live.com\>
|
||||
* starenka \<starenka0 gmail.com\>
|
||||
* Suseika \<wlasowegor gmail.com\>
|
||||
* Uli Schlachter \<psychon znc.in\>
|
||||
* Wtfcoder \<matt mattfreeman.co.uk\>
|
||||
* Xaver Hellauer \<xaver hellauer.bayern\>
|
||||
* zhrtz \<apaterson scramble.io\>
|
||||
* And many others
|
||||
[list of authors]: https://vicious.rtfd.io/copying.html
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
|
@ -0,0 +1 @@
|
|||
Sphinx >= 3
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options.
|
||||
# For a full list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# Project information
|
||||
project = 'Vicious'
|
||||
copyright = '2020, vicious-widgets'
|
||||
author = 'vicious-widgets'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '2.4.2'
|
||||
|
||||
|
||||
# Add any Sphinx extension module names here, as strings.
|
||||
# They can be extensions coming with Sphinx (named 'sphinx.ext.*')
|
||||
# or your custom ones.
|
||||
extensions = ['sphinx.ext.extlinks']
|
||||
extlinks = {'github': ('https://github.com/%s', '@')}
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = []
|
||||
|
||||
# Options for HTML output
|
||||
html_theme = 'alabaster'
|
||||
html_theme_options = {
|
||||
'github_user': 'vicious-widgets', 'github_repo': 'vicious',
|
||||
'github_button': True, 'github_count': False}
|
||||
html_show_copyright = False
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets)
|
||||
# here, relative to this directory. They are copied after the builtin
|
||||
# static files, so a file named "default.css" will overwrite the builtin
|
||||
# "default.css".
|
||||
html_static_path = []
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
License and Credits
|
||||
===================
|
||||
|
||||
Wicked was written by:
|
||||
|
||||
* Lucas de Vries <lucas glacicle.com>
|
||||
|
||||
Vicious was originally written by:
|
||||
|
||||
* Adrian C. (anrxc) <anrxc sysphere.org>.
|
||||
|
||||
Vicious is released under `GNU GPLv2+`_ and is currently maintained by:
|
||||
|
||||
* :github:`Jörg Thalheim <Mic92>` <joerg thalheim.io>
|
||||
* :github:`mutlusun` (especially the FreeBSD port)
|
||||
* :github:`Daniel Hahler <blueyed>` <github thequod.de>
|
||||
* :github:`Nguyễn Gia Phong <McSinyx>` <mcsinyx disroot.org>
|
||||
* :github:`Enric Morales <kiike>` <geekingaround enric.me>
|
||||
(especially the OpenBSD port)
|
||||
|
||||
Over the years, Vicious has also received various patches and improvements
|
||||
from the following contributors, listed in alphabetic order:
|
||||
|
||||
* 0x5b <dragen15051 gmail.com>
|
||||
* Adam Lee <adam8157 gmail.com>
|
||||
* Alexander Koch <lynix47 gmail.com>
|
||||
* Amir Mohammad Saied <amirsaied gmail.com>
|
||||
* Andrea Scarpino <me andreascarpino.it>
|
||||
* Andreas Geisenhainer <psycorama datenhalde.de>
|
||||
* Andrew Merenbach <andrew merenbach.com>
|
||||
* Andrzej Bieniek <andyhelp gmail.com>
|
||||
* Arthur Axel 'fREW' Schmidt <git frew.co>
|
||||
* Arvydas Sidorenko <asido4 gmail.com>
|
||||
* Benedikt Sauer <filmor gmail.com>
|
||||
* Beniamin Kalinowski <beniamin.kalinowski gmail.com>
|
||||
* Benoît Zugmeyer <bzugmeyer gmail.com>
|
||||
* blastmaster <blastmaster tuxcode.org>
|
||||
* Brandon Hartshorn <brandonhartshorn gmail.com>
|
||||
* crondog <patches crondog.com>
|
||||
* David Udelson <dru5 cornell.edu>
|
||||
* Dodo The Last <dodo.the.last gmail.com>
|
||||
* Elric Milon <whirm gmx.com>
|
||||
* getzze <getzze gmail.com>
|
||||
* Greg D. <jabbas jabbas.pl>
|
||||
* Hagen Schink <troja84 googlemail.com>
|
||||
* Henning Glawe <glaweh debian.org>
|
||||
* Hiltjo Posthuma <hiltjo codemadness.org>
|
||||
* :github:`James Reed <supplantr>`
|
||||
* Jay Kamat <jaygkamat gmail.com>
|
||||
* Jeremy <jeremy.sainvil gmaill.com>
|
||||
* jinleileiking <jinleileiking gmail.com>
|
||||
* joe di castro <joe joedicastro.com>
|
||||
* Joerg Jaspert <joerg debian.org>
|
||||
* Jonathan McCrohan <jmccrohan gmail.com>
|
||||
* :github:`Juan Carlos Menonita <JuanKman94>`
|
||||
* Juergen Descher <jhdl gmx.net>
|
||||
* Julian Volodia <julianvolodia gmail.com>
|
||||
* Keith Hughitt <keith.hughitt gmail.com>
|
||||
* Lorenzo Gaggini <lg lgaggini.net>
|
||||
* Lyderic Lefever <lyderic.lefever gmail.com>
|
||||
* Martin Striz <striz raynet.cz>
|
||||
* Martin Ueding <dev martin-ueding.de>
|
||||
* Mellich <mellich gmx.net>
|
||||
* Michael Kressibucher <mkressibucher hotmail.com>
|
||||
* Michael Unterkalmsteiner <miciu gmx.de>
|
||||
* niko <nikomomo gmail.com>
|
||||
* Noah Tilton <code tilton.co>
|
||||
* Normal Ra <normalrawr gmail.com>
|
||||
* Perry Hargrave <perry.hargrave gmail.com>
|
||||
* Rémy CLOUARD <shikamaru shikamaru.fr>
|
||||
* :github:`Roberto <empijei>`
|
||||
* Sébastien Luttringer <seblu seblu.net>
|
||||
* Shadowmourne G <s10e live.com>
|
||||
* starenka <starenka0 gmail.com>
|
||||
* Suseika <wlasowegor gmail.com>
|
||||
* Uli Schlachter <psychon znc.in>
|
||||
* Wtfcoder <matt mattfreeman.co.uk>
|
||||
* Xaver Hellauer <xaver hellauer.bayern>
|
||||
* zhrtz <apaterson scramble.io>
|
||||
|
||||
and many others.
|
||||
|
||||
.. _GNU GPLv2+: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
Welcome to Vicious's documentation!
|
||||
===================================
|
||||
|
||||
Vicious is a modular widget library for window managers, but mostly catering
|
||||
to users of the `awesome window manager`_. It was derived from the old
|
||||
*wicked* widget library, and has some of the old *wicked* widget types,
|
||||
a few of them rewritten, and a good number of new ones.
|
||||
|
||||
Vicious widget types are a framework for creating your own widgets.
|
||||
Vicious contains modules that gather data about your system,
|
||||
and a few *awesome* helper functions that make it easier to register timers,
|
||||
suspend widgets and so on. Vicious doesn't depend on any third party Lua_
|
||||
library, but may depend on additional system utilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
copying
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. _awesome window manager: https://awesomewm.org
|
||||
.. _Lua: https://www.lua.org
|
||||
Loading…
Reference in New Issue