Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/archinstall/general.rst
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2023-11-21 14:34:30 +0100
committerGitHub <noreply@github.com>2023-11-21 14:34:30 +0100
commitcc806d9c4ce29212c2848c15b4b184feace3e1ac (patch)
tree28f4f1cb3b943d178a07a37369d3133093c51e17 /docs/archinstall/general.rst
parente6344f93f7e476d05bbcd642f2ed91fdde545870 (diff)
Started a re-write of the docs (#1967)
* Started a re-write of the docs, using CSV for tables and re-organizing parameter definitions * Added final config options in --config, some have external references which needs to be populated * Forgot to escape a comma * Clarified a note * Added disk configuration and disk encryption docs * Changed way of installing using source and python * Added a 'list script' that lists available scripts. This could be converted to a argparse later. But this does the trick for now. And it's added to ease documentation and listing of available options. * Added a 'Known issues' section, as well as renamed the issues tab * Finished up the known issues section * Added a section regarding --plugin * Added plugin description, tweaked disk_config to the latest changes from #2221 * Added custom-commands docs, and improved some creds and known issue links
Diffstat (limited to 'docs/archinstall/general.rst')
-rw-r--r--docs/archinstall/general.rst117
1 files changed, 0 insertions, 117 deletions
diff --git a/docs/archinstall/general.rst b/docs/archinstall/general.rst
deleted file mode 100644
index 970d40f2..00000000
--- a/docs/archinstall/general.rst
+++ /dev/null
@@ -1,117 +0,0 @@
-.. _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_language
-
-..
- autofunction:: archinstall.Installer.set_keyboard_layout
-
-Services
-========
-
-.. autofunction:: archinstall.service_state
-
-Mirrors
-=======
-
-.. autofunction:: archinstall.filter_mirrors_by_region
-
-.. autofunction:: archinstall.add_custom_mirrors
-
-.. 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_blockdevices
-
-Luks (Disk encryption)
-======================
-
-.. autofunction:: archinstall.luks2
-
-Networking
-==========
-
-.. autofunction:: archinstall.get_hw_addr
-
-.. autofunction:: archinstall.list_interfaces
-
-.. autofunction:: archinstall.check_mirror_reachable
-
-.. autofunction:: archinstall.update_keyring
-
-.. autofunction:: archinstall.enrich_iface_types
-
-.. autofunction:: archinstall.get_interface_from_mac
-
-.. autofunction:: archinstall.wireless_scan
-
-.. autofunction:: archinstall.get_wireless_networks
-
-General
-=======
-
-.. autofunction:: archinstall.log
-
-.. autofunction:: archinstall.locate_binary
-
-.. autofunction:: archinstall.SysCommand
-
-.. autofunction:: archinstall.SysCommandWorker
-
-Exceptions
-==========
-
-.. autofunction:: archinstall.RequirementError
-
-.. autofunction:: archinstall.DiskError
-
-.. autofunction:: archinstall.ProfileError
-
-.. autofunction:: archinstall.SysCallError
-
-.. autofunction:: archinstall.ProfileNotFound
-
-.. autofunction:: archinstall.HardwareIncompatibilityError
-
-.. autofunction:: archinstall.PermissionError
-
-.. autofunction:: archinstall.UserError
-
-.. autofunction:: archinstall.ServiceException