From a91aea315438e7bc2e52a3d3ffb9f2ab0ca1b8e8 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Wed, 30 Sep 2020 22:24:57 +0200 Subject: First complete draft of the documentation. Some autodocs are still unpopulated but will be done via code and not reST chapters. --- docs/index.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 627347e9..31538295 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ python-archinstall Documentation ================================ | **python-archinstall** *(or, archinstall for short)* is a helper library to install Arch Linux and manage services, packages and other things. -| It comes packaged with different installers *(shopped as scripts)*, such as _guided and _automated installer that can be run as _Python modules. +| It comes packaged with different pre-configured installers, such as the `installing.guided`_ installer. | | Here's a `demo `_ using the guided installer. @@ -15,6 +15,12 @@ Some of the features of Archinstall are: * **Supports standalone executable** The library can be compiled into a single executable and run on any system with or without Python. This is ideal for live mediums that don't want to ship Python as a big dependency. +.. toctree:: + :maxdepth: 3 + :caption: Running on ISO + + installing/guided + .. toctree:: :maxdepth: 3 :caption: Installing @@ -48,4 +54,12 @@ Some of the features of Archinstall are: :maxdepth: 3 :caption: API Reference - archinstall/Installer \ No newline at end of file + archinstall/Installer + archinstall/Profile + archinstall/Application + +.. toctree:: + :maxdepth: 3 + :caption: API Helper functions + + archinstall/general \ No newline at end of file -- cgit v1.2.3-54-g00ecf