From cc806d9c4ce29212c2848c15b4b184feace3e1ac Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Tue, 21 Nov 2023 14:34:30 +0100 Subject: 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 --- docs/archinstall/general.rst | 117 ------------------------------------------- 1 file changed, 117 deletions(-) delete mode 100644 docs/archinstall/general.rst (limited to 'docs/archinstall/general.rst') 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 -- cgit v1.2.3-70-g09d2