From b7d08fc84bbff6821108b13e03ff87760e8062ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Gia=20Phong?= Date: Mon, 7 Sep 2020 20:43:25 +0700 Subject: [PATCH] Draft Sphinx doc structure --- .gitignore | 1 + README.md | 82 ++++------------------------------------ docs/Makefile | 20 ++++++++++ docs/requirements.txt | 1 + docs/source/conf.py | 41 ++++++++++++++++++++ docs/source/copying.rst | 83 +++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 28 ++++++++++++++ 7 files changed, 182 insertions(+), 74 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/requirements.txt create mode 100644 docs/source/conf.py create mode 100644 docs/source/copying.rst create mode 100644 docs/source/index.rst diff --git a/.gitignore b/.gitignore index b25c15b..5975d97 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *~ +build/ diff --git a/README.md b/README.md index fd48ee2..133fbe5 100644 --- a/README.md +++ b/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 \ +Please refer to our documentation for the full [list of authors]. -Vicious was originally written by: -* Adrian C. (anrxc) \ - -Current maintainers: - -* Jörg Thalheim (Mic92) \ -* [mutlusun](https://github.com/mutlusun) (especially the FreeBSD port) -* Daniel Hahler (blueyed) \ -* Nguyễn Gia Phong (McSinyx) \ - -Contributors, listed in alphabetic order: - -* 0x5b \ -* Adam Lee \ -* Alexander Koch \ -* Amir Mohammad Saied \ -* Andrea Scarpino \ -* Andreas Geisenhainer \ -* Andrew Merenbach \ -* Andrzej Bieniek \ -* Arthur Axel 'fREW' Schmidt \ -* Arvydas Sidorenko \ -* Benedikt Sauer \ -* Beniamin Kalinowski \ -* Benoît Zugmeyer \ -* blastmaster \ -* Brandon Hartshorn \ -* crondog \ -* David Udelson \ -* Dodo The Last \ -* Elric Milon \ -* Enric Morales \ -* getzze \ -* Greg D. \ -* Hagen Schink \ -* Henning Glawe \ -* Hiltjo Posthuma \ -* [James Reed](https://github.com/supplantr) -* Jay Kamat \ -* Jeremy \ -* jinleileiking \ -* joe di castro \ -* Joerg Jaspert \ -* Jonathan McCrohan \ -* [Juan Carlos Menonita](https://github.com/JuanKman94) -* Juergen Descher \ -* Julian Volodia \ -* Keith Hughitt \ -* Lorenzo Gaggini \ -* Lyderic Lefever \ -* Martin Striz \ -* Martin Ueding \ -* Mellich \ -* Michael Kressibucher \ -* Michael Unterkalmsteiner \ -* niko \ -* Noah Tilton \ -* Normal Ra \ -* Perry Hargrave \ -* Rémy CLOUARD \ -* [Roberto](https://github.com/empijei) -* Sébastien Luttringer \ -* Shadowmourne G \ -* starenka \ -* Suseika \ -* Uli Schlachter \ -* Wtfcoder \ -* Xaver Hellauer \ -* zhrtz \ -* And many others +[list of authors]: https://vicious.rtfd.io/copying.html diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -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) diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..dd83433 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +Sphinx >= 3 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..69491b0 --- /dev/null +++ b/docs/source/conf.py @@ -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 = [] diff --git a/docs/source/copying.rst b/docs/source/copying.rst new file mode 100644 index 0000000..a0a8e20 --- /dev/null +++ b/docs/source/copying.rst @@ -0,0 +1,83 @@ +License and Credits +=================== + +Wicked was written by: + +* Lucas de Vries + +Vicious was originally written by: + +* Adrian C. (anrxc) . + +Vicious is released under `GNU GPLv2+`_ and is currently maintained by: + +* :github:`Jörg Thalheim ` +* :github:`mutlusun` (especially the FreeBSD port) +* :github:`Daniel Hahler ` +* :github:`Nguyễn Gia Phong ` +* :github:`Enric Morales ` + (especially the OpenBSD port) + +Over the years, Vicious has also received various patches and improvements +from the following contributors, listed in alphabetic order: + +* 0x5b +* Adam Lee +* Alexander Koch +* Amir Mohammad Saied +* Andrea Scarpino +* Andreas Geisenhainer +* Andrew Merenbach +* Andrzej Bieniek +* Arthur Axel 'fREW' Schmidt +* Arvydas Sidorenko +* Benedikt Sauer +* Beniamin Kalinowski +* Benoît Zugmeyer +* blastmaster +* Brandon Hartshorn +* crondog +* David Udelson +* Dodo The Last +* Elric Milon +* getzze +* Greg D. +* Hagen Schink +* Henning Glawe +* Hiltjo Posthuma +* :github:`James Reed ` +* Jay Kamat +* Jeremy +* jinleileiking +* joe di castro +* Joerg Jaspert +* Jonathan McCrohan +* :github:`Juan Carlos Menonita ` +* Juergen Descher +* Julian Volodia +* Keith Hughitt +* Lorenzo Gaggini +* Lyderic Lefever +* Martin Striz +* Martin Ueding +* Mellich +* Michael Kressibucher +* Michael Unterkalmsteiner +* niko +* Noah Tilton +* Normal Ra +* Perry Hargrave +* Rémy CLOUARD +* :github:`Roberto ` +* Sébastien Luttringer +* Shadowmourne G +* starenka +* Suseika +* Uli Schlachter +* Wtfcoder +* Xaver Hellauer +* zhrtz + +and many others. + +.. _GNU GPLv2+: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..a0f206f --- /dev/null +++ b/docs/source/index.rst @@ -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