From a91aea315438e7bc2e52a3d3ffb9f2ab0ca1b8e8 Mon Sep 17 00:00:00 2001
From: Anton Hvornum <anton.feeds+github@gmail.com>
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/archinstall/general.rst | 90 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)
 create mode 100644 docs/archinstall/general.rst

(limited to 'docs/archinstall/general.rst')

diff --git a/docs/archinstall/general.rst b/docs/archinstall/general.rst
new file mode 100644
index 00000000..349393de
--- /dev/null
+++ b/docs/archinstall/general.rst
@@ -0,0 +1,90 @@
+.. _archinstall.helpers:
+
+.. warning::
+    All these helper functions are mostly, if not all, related to outside-installation-instructions. Meaning the calls will affect your current running system - and not touch your installed system.
+
+Profile related helpers
+=======================
+
+.. autofunction:: archinstall.list_profiles
+
+Packages
+========
+
+.. autofunction:: archinstall.find_package
+
+.. autofunction:: archinstall.find_packages
+
+Locale related
+==============
+
+.. autofunction:: archinstall.list_keyboard_languages
+
+.. autofunction:: archinstall.search_keyboard_layout
+
+.. autofunction:: archinstall.set_keyboard_layout
+
+Services
+========
+
+.. autofunction:: archinstall.service_state
+
+Mirrors
+=======
+
+.. autofunction:: archinstall.filter_mirrors_by_region
+
+.. autofunction:: archinstall.add_custom_mirror
+
+.. autofunction:: archinstall.insert_mirrors
+
+.. autofunction:: archinstall.use_mirrors
+
+.. autofunction:: archinstall.re_rank_mirrors
+
+.. autofunction:: archinstall.list_mirrors
+
+Disk related
+============
+
+.. autofunction:: archinstall.BlockDevice
+
+.. autofunction:: archinstall.Partition
+
+.. autofunction:: archinstall.Filesystem
+
+.. autofunction:: archinstall.device_state
+
+.. autofunction:: archinstall.all_disks
+
+Luks (Disk encryption)
+======================
+
+.. autofunction:: archinstall.luks2
+
+Networking
+==========
+
+.. autofunction:: archinstall.getHwAddr
+
+.. autofunction:: archinstall.list_interfaces
+
+General
+=======
+
+.. autofunction:: archinstall.log
+
+.. autofunction:: archinstall.locate_binary
+
+.. autofunction:: archinstall.sys_command
+
+Exceptions
+==========
+
+.. autofunction:: archinstall.RequirementError
+
+.. autofunction:: archinstall.DiskError
+
+.. autofunction:: archinstall.ProfileError
+
+.. autofunction:: archinstall.SysCallError
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2