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

Fix docs warnings

This commit is contained in:
Rafael Fontenelle 2021-04-04 10:31:49 -03:00
parent ef021698b6
commit a0a4b5dbfe
4 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/archinstall/general.rst
View File

@ -22,7 +22,7 @@ Locale related
.. autofunction:: archinstall.search_keyboard_layout .. autofunction:: archinstall.search_keyboard_layout
.. autofunction:: archinstall.set_keyboard_layout .. autofunction:: archinstall.set_keyboard_language
Services Services
======== ========
@ -34,7 +34,7 @@ Mirrors
.. autofunction:: archinstall.filter_mirrors_by_region .. autofunction:: archinstall.filter_mirrors_by_region
.. autofunction:: archinstall.add_custom_mirror .. autofunction:: archinstall.add_custom_mirrors
.. autofunction:: archinstall.insert_mirrors .. autofunction:: archinstall.insert_mirrors
@ -87,4 +87,4 @@ Exceptions
.. autofunction:: archinstall.ProfileError .. autofunction:: archinstall.ProfileError
.. autofunction:: archinstall.SysCallError .. autofunction:: archinstall.SysCallError

4
docs/examples/binary.rst
View File

@ -1,4 +1,4 @@
.. _examples.python: .. _examples.binary:
Binary executable Binary executable
================= =================
@ -20,4 +20,4 @@ To run the `guided` installed, all you have to do *(after installing or compilin
./archinstall guided ./archinstall guided
As mentioned, the binary is a bit rudimentary and only supports executing whatever is found directly under `./archinstall/examples`. 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. Anything else won't be found. This is subject to change in the future to make it a bit more flexible.

7
docs/index.rst
View File

@ -43,12 +43,15 @@ Some of the features of Archinstall are:
examples/python examples/python
examples/binary examples/binary
..
examples/scripting examples/scripting
.. toctree:: ..
.. toctree::
:maxdepth: 3 :maxdepth: 3
:caption: Programming Guide :caption: Programming Guide
..
programming_guide/requirements programming_guide/requirements
programming_guide/basic_concept programming_guide/basic_concept
@ -64,4 +67,4 @@ Some of the features of Archinstall are:
:maxdepth: 3 :maxdepth: 3
:caption: API Helper functions :caption: API Helper functions
archinstall/general archinstall/general

8
docs/installing/binary.rst
View File

@ -1,10 +1,10 @@
.. _installing.binary .. _installing.binary:
Binary executable Binary executable
================= =================
Archinstall can be compiled into a standalone 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:: .. 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. 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.
@ -37,7 +37,7 @@ Which should produce a `archinstall-X.x.z-1.pkg.tar.zst` that can be installed u
.. note:: .. 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 Manual compilation
------------------ ------------------
@ -49,4 +49,4 @@ Simply clone or download the source, and while standing in the cloned folder `./
nuitka3 --standalone --show-progress archinstall 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. This requires the `nuitka <https://archlinux.org/packages/community/any/nuitka/>`_ package as well as `python3` to be installed locally.