Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2021-04-06 16:31:31 +0000
committerGitHub <noreply@github.com>2021-04-06 16:31:31 +0000
commitce2ebc0026573f7b4ce4231a8715de512df02c0a (patch)
treebb24a85db36b0d26aab019d79d0cbe9ad0f756de /docs
parent3da4dc8e3015479e64603987ae229f75e2146548 (diff)
parent27853bf444b2f5c3355be58409106bc5fa1c2c4b (diff)
Merge branch 'master' into fix-undef-vars
Diffstat (limited to 'docs')
-rw-r--r--docs/archinstall/general.rst6
-rw-r--r--docs/examples/binary.rst6
-rw-r--r--docs/help/discord.rst2
-rw-r--r--docs/help/issues.rst2
-rw-r--r--docs/index.rst7
-rw-r--r--docs/installing/binary.rst10
-rw-r--r--docs/installing/guided.rst4
-rw-r--r--docs/installing/python.rst2
-rw-r--r--docs/pull_request_template.md2
9 files changed, 22 insertions, 19 deletions
diff --git a/docs/archinstall/general.rst b/docs/archinstall/general.rst
index 349393de..0403ae30 100644
--- a/docs/archinstall/general.rst
+++ b/docs/archinstall/general.rst
@@ -22,7 +22,7 @@ Locale related
.. autofunction:: archinstall.search_keyboard_layout
-.. autofunction:: archinstall.set_keyboard_layout
+.. autofunction:: archinstall.set_keyboard_language
Services
========
@@ -34,7 +34,7 @@ Mirrors
.. autofunction:: archinstall.filter_mirrors_by_region
-.. autofunction:: archinstall.add_custom_mirror
+.. autofunction:: archinstall.add_custom_mirrors
.. autofunction:: archinstall.insert_mirrors
@@ -87,4 +87,4 @@ Exceptions
.. autofunction:: archinstall.ProfileError
-.. autofunction:: archinstall.SysCallError \ No newline at end of file
+.. autofunction:: archinstall.SysCallError
diff --git a/docs/examples/binary.rst b/docs/examples/binary.rst
index 6940d591..51dbd1dd 100644
--- a/docs/examples/binary.rst
+++ b/docs/examples/binary.rst
@@ -1,4 +1,4 @@
-.. _examples.python:
+.. _examples.binary:
Binary executable
=================
@@ -11,7 +11,7 @@ It's compiled using `nuitka <https://nuitka.net/>`_ with the flag `--standalone`
Executing the binary
--------------------
-As an example we'll use the `guided <https://github.com/Torxed/archinstall/blob/master/examples/guided.py>`_ installer.
+As an example we'll use the `guided <https://github.com/archlinux/archinstall/blob/master/examples/guided.py>`_ installer.
To run the `guided` installed, all you have to do *(after installing or compiling the binary)*, is run:
@@ -20,4 +20,4 @@ To run the `guided` installed, all you have to do *(after installing or compilin
./archinstall guided
As mentioned, the binary is a bit rudimentary and only supports executing whatever is found directly under `./archinstall/examples`.
-Anything else won't be found. This is subject to change in the future to make it a bit more flexible. \ No newline at end of file
+Anything else won't be found. This is subject to change in the future to make it a bit more flexible.
diff --git a/docs/help/discord.rst b/docs/help/discord.rst
index 609fbecb..ce15766a 100644
--- a/docs/help/discord.rst
+++ b/docs/help/discord.rst
@@ -3,7 +3,7 @@
Discord
=======
-There's a discord channel which is frequent by some `contributors <https://github.com/Torxed/archinstall/graphs/contributors>`_.
+There's a discord channel which is frequent by some `contributors <https://github.com/archlinux/archinstall/graphs/contributors>`_.
To join the server, head over to `https://discord.gg/cqXU88y <https://discord.gg/cqXU88y>`_'s server and join in.
There's not many rules other than common sense and treat others with respect.
diff --git a/docs/help/issues.rst b/docs/help/issues.rst
index f29b18cc..d4f71b70 100644
--- a/docs/help/issues.rst
+++ b/docs/help/issues.rst
@@ -3,7 +3,7 @@
Issue tracker & bugs
====================
-Issues and bugs should be reported over at `https://github.com/Torxed/archinstall/issues <https://github.com/Torxed/archinstall/issues>`_.
+Issues and bugs should be reported over at `https://github.com/archlinux/archinstall/issues <https://github.com/Torxed/archinstall/issues>`_.
General questions, enhancements and security issues can be reported over there too.
For quick issues or if you need help, head over the to the Discord server which has a help channel.
diff --git a/docs/index.rst b/docs/index.rst
index eef368c5..deb2734e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -43,12 +43,15 @@ Some of the features of Archinstall are:
examples/python
examples/binary
+..
examples/scripting
-.. toctree::
+..
+ .. toctree::
:maxdepth: 3
:caption: Programming Guide
+..
programming_guide/requirements
programming_guide/basic_concept
@@ -64,4 +67,4 @@ Some of the features of Archinstall are:
:maxdepth: 3
:caption: API Helper functions
- archinstall/general \ No newline at end of file
+ archinstall/general
diff --git a/docs/installing/binary.rst b/docs/installing/binary.rst
index c51fb2c0..504d6e3e 100644
--- a/docs/installing/binary.rst
+++ b/docs/installing/binary.rst
@@ -1,10 +1,10 @@
-.. _installing.binary
+.. _installing.binary:
Binary executable
=================
Archinstall can be compiled into a standalone executable.
-For Arch Linux based systems, there's a package for this called `archinstall <https://archlinux.life/>`_.
+For Arch Linux based systems, there's a package for this called `archinstall <https://archlinux.org/packages/extra/any/archinstall/>`_.
.. warning::
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.
@@ -21,7 +21,7 @@ Archinstall is on the `official repositories <https://wiki.archlinux.org/index.p
Using PKGBUILD
--------------
-The `source <https://github.com/Torxed/archinstall>`_ contains a binary `PKGBUILD <https://github.com/Torxed/archinstall/tree/master/PKGBUILD/archinstall>`_ which can be either copied straight off the website. Or cloned using `git clone https://github.com/Torxed/archinstall`.
+The `source <https://github.com/archlinux/archinstall>`_ contains a binary `PKGBUILD <https://github.com/Torxed/archinstall/tree/master/PKGBUILD/archinstall>`_ which can be either copied straight off the website. Or cloned using `git clone https://github.com/Torxed/archinstall`.
Once you've obtained the `PKGBUILD`, building it is pretty straight forward.
@@ -37,7 +37,7 @@ Which should produce a `archinstall-X.x.z-1.pkg.tar.zst` that can be installed u
.. note::
- For a complete guide on the build process, please consult the wiki on `PKGBUILD <https://wiki.archlinux.org/index.php/PKGBUILD>`_.
+ For a complete guide on the build process, please consult the `PKGBUILD on ArchWiki <https://wiki.archlinux.org/index.php/PKGBUILD>`_.
Manual compilation
------------------
@@ -49,4 +49,4 @@ Simply clone or download the source, and while standing in the cloned folder `./
nuitka3 --standalone --show-progress archinstall
-This requires the `nuitka <https://archlinux.org/packages/community/any/nuitka/>`_ package as well as `python3` to be installed locally. \ No newline at end of file
+This requires the `nuitka <https://archlinux.org/packages/community/any/nuitka/>`_ package as well as `python3` to be installed locally.
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index 7ce081ca..2e1cda09 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -66,7 +66,7 @@ Default is :code:`auto detect best mirror`
As an example:
- * :code:`Sweden` *(wich a capital :code:`S`)* will only use mirrors from Sweden.
+ * :code:`Sweden` *(with a capital :code:`S`)* will only use mirrors from Sweden.
Selection of drive
------------------
@@ -175,4 +175,4 @@ After which you can press :code:`Enter` can be pressed in order to start the for
Post installation
-----------------
-Once the installation is complete, green text should appear saying that it's safe to `reboot`, which is also the command you use to reboot. \ No newline at end of file
+Once the installation is complete, green text should appear saying that it's safe to `reboot`, which is also the command you use to reboot.
diff --git a/docs/installing/python.rst b/docs/installing/python.rst
index 94cfb243..68365753 100644
--- a/docs/installing/python.rst
+++ b/docs/installing/python.rst
@@ -54,7 +54,7 @@ Or you can clone it, we'll clone it here but both methods work the same.
.. code-block:: console
- git clone https://github.com/Torxed/archinstall
+ git clone https://github.com/archlinux/archinstall
Either you can move the folder into your project and simply do
diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md
index 886ea244..6da175ae 100644
--- a/docs/pull_request_template.md
+++ b/docs/pull_request_template.md
@@ -1,6 +1,6 @@
# Pull Request Template
-Make sure you've checked out the [contribution guideline](https://github.com/Torxed/archinstall/blob/master/CONTRIBUTING.md).<br>
+Make sure you've checked out the [contribution guideline](https://github.com/archlinux/archinstall/blob/master/CONTRIBUTING.md).<br>
Most of the guidelines are not enforced, but is heavily encouraged.
## Description