From be0eb4870d76f79e49ee24dc2c43d37f8084f894 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Gia=20Phong?= Date: Tue, 8 Sep 2020 22:32:36 +0700 Subject: [PATCH] [docs] Move *See also* from README --- README.md | 10 ---------- docs/source/index.rst | 21 ++++++++++++++++----- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e992b3c..c1ea57c 100644 --- a/README.md +++ b/README.md @@ -751,16 +751,6 @@ mybattery:buttons(awful.util.table.join( ``` -## See also - -* Manual pages: [awesome(1)](https://awesomewm.org/doc/manpages/awesome), - [awesomerc(5)](https://awesomewm.org/doc/manpages/awesomerc.5.html) -* [Awesome declarative layout system](https://awesomewm.org/apidoc/documentation/03-declarative-layout.md.html) -* [Example *awesome* configuration](http://git.sysphere.org/awesome-configs/) - (outdated) -* [My first awesome](https://awesomewm.org/doc/api/documentation/07-my-first-awesome.md.html) - - ## Contributing For details, see CONTRIBUTING.md. Vicious is licensed under GNU GPLv2+, diff --git a/docs/source/index.rst b/docs/source/index.rst index cfec428..f7562f5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,19 +12,30 @@ 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. +Table of Contents +----------------- + .. toctree:: :maxdepth: 2 - :caption: Contents: usage-lua usage-awesome copying -Indices and tables ------------------- +See Also +-------- -* :ref:`genindex` -* :ref:`search` +* Manual pages: `awesome(1)`_, `awesomerc(5)`_ +* `Awesome declarative layout system`_ +* `My first awesome`_ +* `Example awesome configuration`_ (outdated) .. _awesome window manager: https://awesomewm.org .. _Lua: https://www.lua.org +.. _awesome(1): https://awesomewm.org/doc/manpages/awesome.1.html +.. _awesomerc(5): https://awesomewm.org/doc/manpages/awesomerc.5.html +.. _Awesome declarative layout system: + https://awesomewm.org/apidoc/documentation/03-declarative-layout.md.html +.. _My first awesome: + https://awesomewm.org/doc/api/documentation/07-my-first-awesome.md.html +.. _Example awesome configuration: http://git.sysphere.org/awesome-configs/