From a0a4b5dbfea72b28163b3ba50934f0b34d4ff212 Mon Sep 17 00:00:00 2001 From: Rafael Fontenelle Date: Sun, 4 Apr 2021 10:31:49 -0300 Subject: Fix docs warnings --- docs/archinstall/general.rst | 6 +++--- docs/examples/binary.rst | 4 ++-- docs/index.rst | 7 +++++-- docs/installing/binary.rst | 8 ++++---- 4 files changed, 14 insertions(+), 11 deletions(-) (limited to 'docs') 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..8f7b51fe 100644 --- a/docs/examples/binary.rst +++ b/docs/examples/binary.rst @@ -1,4 +1,4 @@ -.. _examples.python: +.. _examples.binary: Binary executable ================= @@ -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/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..9c6757b2 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 `_. +For Arch Linux based systems, there's a package for this called `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. @@ -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 `_. + For a complete guide on the build process, please consult the `PKGBUILD on ArchWiki `_. 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 `_ package as well as `python3` to be installed locally. \ No newline at end of file +This requires the `nuitka `_ package as well as `python3` to be installed locally. -- cgit v1.2.3-54-g00ecf