From 410a0ba0b3065acd3db09bcd511036975fa0967f Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Mon, 28 Sep 2020 16:38:10 +0200 Subject: Added documentation for: https://python-archinstall.readthedocs.io/en/latest/ --- docs/index.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docs/index.rst (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..627347e9 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,51 @@ +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. +| +| Here's a `demo `_ using the guided installer. + + +Some of the features of Archinstall are: + +* **No external dependencies or installation requirements.** Runs without any external requirements or installation processes. + +* **Single threaded and context friendly.** The library always executed calls in sequential order to ensure installation-steps don't overlap or executes in the wrong order. It also supports *(and uses)* context wrappers to ensure things such as `sync` are called so data and configurations aren't lost. + +* **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: Installing + + installing/python + installing/binary + +.. toctree:: + :maxdepth: 3 + :caption: Usage & Examples + + examples/python + examples/binary + examples/scripting + +.. toctree:: + :maxdepth: 3 + :caption: Programming Guide + + programming_guide/requirements + programming_guide/basic_concept + +.. toctree:: + :maxdepth: 3 + :caption: Getting help + + help/discord + help/issues + +.. toctree:: + :maxdepth: 3 + :caption: API Reference + + archinstall/Installer \ No newline at end of file -- cgit v1.2.3-54-g00ecf