RomanNum3ral
/
archinstall
mirror of https://github.com/archlinux/archinstall.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #138 from kusakata/fix-doc-issues 

Fix doc issues
This commit is contained in:
Anton Hvornum 2021-04-02 08:57:45 +00:00 committed by GitHub
parent 2c90f02b6b cd3553ad89
commit 2fd570167d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/examples/python.rst
View File

@ -9,9 +9,9 @@ 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. 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-requisites Pre-requisites
------------- --------------
We'll assume you've followed the `installing.python.manual`_ method. We'll assume you've followed the :ref:`installing.python.manual` method.
Before actually installing the library, you will need to place your custom installer-scripts under `./archinstall/examples/` as a python file. Before actually installing the library, you will need to place your custom installer-scripts under `./archinstall/examples/` as a python file.
More on how you create these in the next section. More on how you create these in the next section.

2
docs/index.rst
View File

@ -2,7 +2,7 @@ python-archinstall Documentation
================================ ================================
| **python-archinstall** *(or, archinstall for short)* is a helper library to install Arch Linux and manage services, packages and other things. | **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 pre-configured installers, such as the `installing.guided`_ installer. | It comes packaged with different pre-configured installers, such as the :ref:`guided <installing.guided>` installer.
| |
| A demo can be viewed here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_ which uses the default guided installer. | A demo can be viewed here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_ which uses the default guided installer.

4
docs/installing/guided.rst
View File

@ -100,6 +100,8 @@ Default is :code:`Archinstall`
The hostname in which the machine will identify itself on the local network. The hostname in which the machine will identify itself on the local network.
This step is optional, but a default hostname of `Archinstall` will be set if none is selected. This step is optional, but a default hostname of `Archinstall` will be set if none is selected.
.. _root_password:
Root password Root password
------------- -------------
@ -115,7 +117,7 @@ Super User (sudo)
----------------- -----------------
.. warning:: .. warning::
This step only applies if you correctly skipped the previous step :ref:`root_password`_ which also makes this step mandatory. This step only applies if you correctly skipped :ref:`the previous step <root_password>` which also makes this step mandatory.
If the previous step was skipped, and only if it is skipped. If the previous step was skipped, and only if it is skipped.
This step enables you to create a :code:`sudo` enabled user with a password. This step enables you to create a :code:`sudo` enabled user with a password.

4
docs/installing/python.rst
View File

@ -10,7 +10,7 @@ But the library can be installed manually as well.
This is not required if you're running archinstall on a pre-built ISO. The installation is only required if you're creating your own scripted installations. This is not required if you're running archinstall on a pre-built ISO. The installation is only required if you're creating your own scripted installations.
Using pacman Using pacman
---------- ------------
Archinstall is on the `official repositories <https://wiki.archlinux.org/index.php/Official_repositories>`_. Archinstall is on the `official repositories <https://wiki.archlinux.org/index.php/Official_repositories>`_.
@ -44,7 +44,7 @@ Or as a user module:
Which will allow you to start using the library. Which will allow you to start using the library.
.. _installing.python.manual .. _installing.python.manual:
Manual installation Manual installation
------------------- -------------------