Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2021-04-02 08:57:45 +0000
committerGitHub <noreply@github.com>2021-04-02 08:57:45 +0000
commit2fd570167d474f17c3fbb60a938e44d37602df89 (patch)
tree4d3fad5bf937176727993a09be927f27e41009cb
parent2c90f02b6b26cc489e90f7536fe8931a4b2b9195 (diff)
parentcd3553ad89b5dfedd49f985fc5aa397fcd96c81d (diff)
Merge pull request #138 from kusakata/fix-doc-issues
Fix doc issues
-rw-r--r--docs/examples/python.rst4
-rw-r--r--docs/index.rst2
-rw-r--r--docs/installing/guided.rst4
-rw-r--r--docs/installing/python.rst4
4 files changed, 8 insertions, 6 deletions
diff --git a/docs/examples/python.rst b/docs/examples/python.rst
index 04f2f43a..f6388738 100644
--- a/docs/examples/python.rst
+++ b/docs/examples/python.rst
@@ -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.
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.
More on how you create these in the next section.
diff --git a/docs/index.rst b/docs/index.rst
index c03cc451..eef368c5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -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.
-| 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.
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index 92324589..7ce081ca 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -100,6 +100,8 @@ Default is :code:`Archinstall`
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.
+.. _root_password:
+
Root password
-------------
@@ -115,7 +117,7 @@ Super User (sudo)
-----------------
.. 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.
This step enables you to create a :code:`sudo` enabled user with a password.
diff --git a/docs/installing/python.rst b/docs/installing/python.rst
index 44606166..94cfb243 100644
--- a/docs/installing/python.rst
+++ b/docs/installing/python.rst
@@ -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.
Using pacman
-----------
+------------
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.
-.. _installing.python.manual
+.. _installing.python.manual:
Manual installation
-------------------