index : archinstall32 | |
Archlinux32 installer | gitolite user |
summaryrefslogtreecommitdiff |
author | Anton Hvornum <anton.feeds+github@gmail.com> | 2020-10-20 20:39:46 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-20 20:39:46 +0200 |
commit | 2fc51d540a78da3d7cf24b595a611f45915a55d0 (patch) | |
tree | 4e2b46493fadf9cf777e9371545a2e93d1510b17 /docs | |
parent | f32f1e238a0a36b0d1b5220df6f6f053c6c4168c (diff) | |
parent | 5ded22a5d0f5fb1cf1d4d95945f655e8b6a33896 (diff) |
-rw-r--r-- | docs/archinstall/Application.rst | 2 | ||||
-rw-r--r-- | docs/archinstall/Profile.rst | 2 | ||||
-rw-r--r-- | docs/conf.py | 29 | ||||
-rw-r--r-- | docs/examples/python.rst | 2 | ||||
-rw-r--r-- | docs/installing/guided.rst | 6 | ||||
-rw-r--r-- | docs/installing/python.rst | 2 |
diff --git a/docs/archinstall/Application.rst b/docs/archinstall/Application.rst index 72722362..c6eb0d4d 100644 --- a/docs/archinstall/Application.rst +++ b/docs/archinstall/Application.rst @@ -4,7 +4,7 @@ archinstall.Application ======================= This class enables access to pre-programmed application configurations. -This is not to be confused with :ref:`archinstall.Profile` which is for pre-prgrammed profiles for a wider set of installation sets. +This is not to be confused with :ref:`archinstall.Profile` which is for pre-programmed profiles for a wider set of installation sets. .. autofunction:: archinstall.Application diff --git a/docs/archinstall/Profile.rst b/docs/archinstall/Profile.rst index 0f57c68c..a4c1f3bb 100644 --- a/docs/archinstall/Profile.rst +++ b/docs/archinstall/Profile.rst @@ -4,7 +4,7 @@ archinstall.Profile =================== This class enables access to pre-programmed profiles. -This is not to be confused with :ref:`archinstall.Application` which is for pre-prgrammed application profiles. +This is not to be confused with :ref:`archinstall.Application` which is for pre-programmed application profiles. Profiles in general is a set or group of installation steps. Where as applications are a specific set of instructions for a very specific application. diff --git a/docs/conf.py b/docs/conf.py index 63e08e8a..02e6cb92 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,17 +1,18 @@ -import sys, os +import os +import re +import sys sys.path.insert(0, os.path.abspath('..')) -import re def process_docstring(app, what, name, obj, options, lines): - spaces_pat = re.compile(r"( {8})") - ll = [] - for l in lines: - ll.append(spaces_pat.sub(" ",l)) - lines[:] = ll + spaces_pat = re.compile(r"( {8})") + ll = [] + for l in lines: + ll.append(spaces_pat.sub(" ", l)) + lines[:] = ll def setup(app): - app.connect('autodoc-process-docstring', process_docstring) + app.connect('autodoc-process-docstring', process_docstring) # Configuration file for the Sphinx documentation builder. # @@ -110,8 +111,10 @@ htmlhelp_basename = 'slimhttpdoc' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'archinstall', u'archinstall Documentation', - [u'Anton Hvornum'], 1) + ( + "index", "archinstall", u"archinstall Documentation", + [u"Anton Hvornum"], 1 + ) ] # If true, show URL addresses after external links. @@ -124,6 +127,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'archinstall', u'archinstall Documentation', - u'Anton Hvornum', 'archinstall', 'Simple and minimal HTTP server.'), + ( + "index", "archinstall", u"archinstall Documentation", + u"Anton Hvornum", "archinstall", "Simple and minimal HTTP server." + ), ] diff --git a/docs/examples/python.rst b/docs/examples/python.rst index 2f7c9301..04f2f43a 100644 --- a/docs/examples/python.rst +++ b/docs/examples/python.rst @@ -8,7 +8,7 @@ The way the library is invoked in module mode is limited to executing scripts un It's there for important to place any script or profile you wish to invoke in the examples folder prior to building and installing. -Pre-requisits +Pre-requisites ------------- We'll assume you've followed the `installing.python.manual`_ method. diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst index a9b5ab3b..19aee62c 100644 --- a/docs/installing/guided.rst +++ b/docs/installing/guided.rst @@ -3,14 +3,14 @@ Guided installation =================== -This is the installer you'll encounter on the *(currently)* inofficial Arch Linux Archinstall ISO found on `archlinux.life <https://archlinux.life>`_. +This is the installer you'll encounter on the *(currently)* unofficial Arch Linux Archinstall ISO found on `archlinux.life <https://archlinux.life>`_. You'll obviously need a physical machine or a virtual machine and have a basic understanding of how ISO-files work, where and how to mount them in order to boot the installer. It runs you through a set of questions in order to determine what the system should look like. Then the guided installer performs the required installation steps for you. Some additional steps might show up depending on your chosen input at some of the steps - those steps should be self explanatory and won't be covered here. .. note:: - There are some limitations with the installer, such as that it will not configure WiFi during the installation proceedure. And it will not perform a post-installation network configuration either. So you need to read up on `Arch Linux networking <https://wiki.archlinux.org/index.php/Network_configuration>`_ to get that to work. + There are some limitations with the installer, such as that it will not configure WiFi during the installation procedure. And it will not perform a post-installation network configuration either. So you need to read up on `Arch Linux networking <https://wiki.archlinux.org/index.php/Network_configuration>`_ to get that to work. Features -------- @@ -18,7 +18,7 @@ Features The guided installer currently supports: * *(optional)* Setting up disk encryption - * *(optional)* Installing some simpel desktop environments + * *(optional)* Installing some simple desktop environments * Choosing between a super-user or root based user setup Installation steps diff --git a/docs/installing/python.rst b/docs/installing/python.rst index ae80e76e..ca34b1af 100644 --- a/docs/installing/python.rst +++ b/docs/installing/python.rst @@ -3,7 +3,7 @@ Python library ============== -Archinstall shipps on `PyPi <https://pypi.org/>`_ as `archinstall <pypi.org/project/archinstall/>`_. +Archinstall ships on `PyPi <https://pypi.org/>`_ as `archinstall <pypi.org/project/archinstall/>`_. But the library can be installed manually as well. .. warning:: |