archinstall/docs
Softer ef1cfe7b56
Add share-log subcommand to upload install.log to paste.rs (#4511)
* Add --share-log flag to upload install.log to paste.rs

* Apply ruff-format to share_log.py

* Rework share-log per review: subcommand, TUI confirmation, truncate large logs

* Replace curl/SysCommand with urllib.request, remove defensive try/except

Per review: use stdlib urllib instead of shelling out to curl,
drop unnecessary try/except around TUI confirmation,
remove tempfile (content is passed directly as bytes).

* Fix TUI imports after ui module was pulled one level up (#4515)

* Decouple share_install_log from TUI module

* Add unit tests for share_install_log function

* Update docs to use share-log subcommand syntax
2026-05-07 10:18:56 +10:00
..
_static Integrate new curses menu (#2663) 2024-11-15 08:23:22 +01:00
_templates Integrate new curses menu (#2663) 2024-11-15 08:23:22 +01:00
archinstall Integrate new curses menu (#2663) 2024-11-15 08:23:22 +01:00
cli_parameters/config Add dialog to install EFI bootloader to removable location (#3932) 2025-11-21 11:41:24 +11:00
examples Refactor PartitionType (#4432) 2026-04-16 14:05:08 +10:00
flowcharts Integrate new curses menu (#2663) 2024-11-15 08:23:22 +01:00
help Add share-log subcommand to upload install.log to paste.rs (#4511) 2026-05-07 10:18:56 +10:00
installing Add dialog to install EFI bootloader to removable location (#3932) 2025-11-21 11:41:24 +11:00
Makefile Added documentation for: https://python-archinstall.readthedocs.io/en/latest/ 2020-09-28 16:38:10 +02:00
README.md Integrate new curses menu (#2663) 2024-11-15 08:23:22 +01:00
conf.py Update ruff formatter (#3496) 2025-05-24 07:58:42 +00:00
index.rst Fix typos (#4109) 2026-01-11 10:28:53 +11:00
logo.png Run oxipng/svgo against the images to save 40KB (#2420) 2024-07-11 20:05:26 +02:00
pull_request_template.md Integrate new curses menu (#2663) 2024-11-15 08:23:22 +01:00

README.md

Dependencies

In order to build the docs locally, you need to have the following installed:

For example, you may install these dependencies using pip:

pip install -U sphinx sphinx-rtd-theme

For other installation methods refer to the docs of the dependencies.

Build

In archinstall/docs, run make html (or specify another target) to build locally. The build files will be in archinstall/docs/_build. Open _build/html/index.html with your browser to see your changes in action.