Commit graph

7593 commits

Author SHA1 Message Date
parulin
dbbed6af86
Restoring Fedora and Debian instructions
Fixing a previous mistake.
2025-08-18 03:10:23 -04:00
parulin
1154873370
Merge branch 'rst' into paragraphs-workaround-2 2025-08-16 14:37:18 -04:00
parulin
5281f045dc
Trying to fix my mistakes ... 2025-08-16 14:28:31 -04:00
qubedmaiska
def5eec5c9
Extract session comments into instructions 2025-08-16 14:23:13 -04:00
qubedmaiska
49c9f9c11c
Remove obsolete prompts, extract session comments to instructions 2025-08-16 14:23:11 -04:00
qubedmaiska
43493b38e6
Add prompts to all code blocks with bash session 2025-08-16 14:23:09 -04:00
qubedmaiska
6c987d00d4
Add 'Edit on GitHub' Link 2025-08-16 14:23:07 -04:00
parulin
651229c10d
Change again some languages
Thanks to @tokideveloper !!!
2025-08-16 14:23:06 -04:00
parulin
bffc808d0a
Two code-block language mistakes 2025-08-16 14:23:04 -04:00
parulin
483fce4c63
Minor cleaning of code highlighting
* Most of text blocks are in fact output blocks
* On qubes-iso-building.rst, try to get something correct for console
  lines starting with a comment
* Fixing a wrong :menuselection: item.

Statistics:

    685 console
     79 text
     44 bash
     35 output
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html
2025-08-16 14:23:02 -04:00
parulin
0ff244e167
Correct code-block lexers
Changing `bash` lexer to `console` because it is appropriate most of
the time. Then after a manual review, some lexer have been changed.

I used `text` each time I was unsure, and for prompt outputs.

The page `/developer/building/qubes-iso-building.rst` still need to be
reviewed (look for lines starting with `$ #`).

I'm not sure about the Windows pages, should we use
[doscon](https://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer)
or `powershell`?

Is there an appropriate lexer for `guid.conf` content?

**Statistics - Before**
    870 bash
      9 python
      9 c
      2 yaml

**Statistics - After**
    684 console
    111 text
     44 bash
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html

This suggests that the default lexer should be `console`.
2025-08-16 14:23:00 -04:00
parulin
fa7a62b529
Use console lexer instead of bash with a prompt 2025-08-16 14:22:55 -04:00
parulin
d541882733
Revert some configuration options
* reuse html builder
* rename videos extension to youtube_frame
* remove HTML body max/min parameters
* remove reference to release number in HTML title
2025-08-16 14:22:31 -04:00
parulin
f5a660954d
Ignore the _build directory 2025-08-16 14:22:29 -04:00
parulin
2531253dce
Add minimal configuration for linkcheck builder
* Avoid checking .onion domains.
* Do not download links to check anchors
2025-08-16 14:22:26 -04:00
parulin
4ebc721ef8
Cleanup sphinx and readthedocs configurations
* Use dirhtml as default builder for readthedocs (clean URLs)
* The configuration variables are now sorted with respect to the Sphinx
  documentation
* Remove useless comments in conf.py
* Add new comments for each section, following Sphinx documentation
  order
* The code corresponding to videos have been moved from config to a
  dedicated extension.
* Use proper HTML theme options
* Exclude all files starting with `.`, `_` (sphinx convention)
* Use OpenSearch
2025-08-16 14:22:24 -04:00
parulin
acc9a5f27d
Fix Xen link on intro.rst 2025-08-16 14:22:23 -04:00
parulin
1f331a4f00
Introduction: correct an image position 2025-08-16 14:22:21 -04:00
parulin
4fa0d293bd
Remove duplicate captions and wrong alt formatting of images 2025-08-16 14:22:17 -04:00
Marek Marczykowski-Górecki
9e5fa7a387
ci: remove gitlab ci
RTD provides own CI service
2025-08-16 14:22:16 -04:00
qubedmaiska
e3e699fa5e
Extract session comments into instructions 2025-08-16 09:31:12 -04:00
qubedmaiska
f96169ba0e
Remove obsolete prompts, extract session comments to instructions 2025-08-16 09:17:57 -04:00
qubedmaiska
2d2bcb06a6
Add prompts to all code blocks with bash session 2025-08-15 16:49:01 -04:00
qubedmaiska
b0395e618c
Add 'Edit on GitHub' Link 2025-08-15 16:44:04 -04:00
qubedmaiska
d4e09e079f
Merge remote-tracking branch 'parulin/clean-code-block-console' into rst 2025-08-15 13:57:46 -04:00
qubedmaiska
c093326662
XMerge remote-tracking branch 'parulin/clean-conf-py' into rst 2025-08-14 16:48:28 -04:00
parulin
43dd7426b1
Revert some configuration options
* reuse html builder
* rename videos extension to youtube_frame
* remove HTML body max/min parameters
* remove reference to release number in HTML title
2025-08-12 09:25:54 -04:00
qubedmaiska
6f88e99e28
Merge remote-tracking branch 'parulin/correct-intro' into rst 2025-08-10 18:27:37 -04:00
qubedmaiska
a60be307bb
Merge remote-tracking branch 'parulin/migration-alt-captions' into rst 2025-08-10 18:20:29 -04:00
parulin
c5a053d12e
Fix missing cell in table 2025-08-09 17:58:19 -04:00
parulin
db47feb239
Fix some missing code blocks inside lists 2025-08-09 17:58:19 -04:00
parulin
8489fcc4fa
Migration: fix indented lists and raw html tables
All raw directives have been removed or replaced by reStructuredText
list-tables.
2025-08-09 17:58:19 -04:00
parulin
3ba7a492f0
Change again some languages
Thanks to @tokideveloper !!!
2025-08-09 17:39:16 -04:00
parulin
978efb3514
Two code-block language mistakes 2025-08-08 16:55:35 -04:00
parulin
6f4370f793
Minor cleaning of code highlighting
* Most of text blocks are in fact output blocks
* On qubes-iso-building.rst, try to get something correct for console
  lines starting with a comment
* Fixing a wrong :menuselection: item.

Statistics:

    685 console
     79 text
     44 bash
     35 output
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html
2025-08-08 16:55:35 -04:00
parulin
4212c5eda8
Correct code-block lexers
Changing `bash` lexer to `console` because it is appropriate most of
the time. Then after a manual review, some lexer have been changed.

I used `text` each time I was unsure, and for prompt outputs.

The page `/developer/building/qubes-iso-building.rst` still need to be
reviewed (look for lines starting with `$ #`).

I'm not sure about the Windows pages, should we use
[doscon](https://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer)
or `powershell`?

Is there an appropriate lexer for `guid.conf` content?

**Statistics - Before**
    870 bash
      9 python
      9 c
      2 yaml

**Statistics - After**
    684 console
    111 text
     44 bash
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html

This suggests that the default lexer should be `console`.
2025-08-08 16:55:35 -04:00
parulin
a252dc4338
Use console lexer instead of bash with a prompt 2025-08-08 16:55:34 -04:00
parulin
31c890baa1
Remove duplicate captions and wrong alt formatting of images 2025-08-08 16:52:48 -04:00
Marek Marczykowski-Górecki
810901e5d6
ci: remove gitlab ci
RTD provides own CI service
2025-08-08 22:51:05 +02:00
parulin
f9cbfad0a3
Ignore the _build directory 2025-08-08 16:39:37 -04:00
parulin
31489845be
Add minimal configuration for linkcheck builder
* Avoid checking .onion domains.
* Do not download links to check anchors
2025-08-08 16:39:23 -04:00
parulin
23f3e2f4cc
Cleanup sphinx and readthedocs configurations
* Use dirhtml as default builder for readthedocs (clean URLs)
* The configuration variables are now sorted with respect to the Sphinx
  documentation
* Remove useless comments in conf.py
* Add new comments for each section, following Sphinx documentation
  order
* The code corresponding to videos have been moved from config to a
  dedicated extension.
* Use proper HTML theme options
* Exclude all files starting with `.`, `_` (sphinx convention)
* Use OpenSearch
2025-08-08 16:38:54 -04:00
parulin
21e631272d
Fix Xen link on intro.rst 2025-08-08 16:22:33 -04:00
parulin
62eafae504
Introduction: correct an image position 2025-08-08 16:22:21 -04:00
Marek Marczykowski-Górecki
d428c3bf29
Update documentation version number 2025-08-06 02:20:01 +02:00
Marek Marczykowski-Górecki
f058f77394
manual fixes
Manual fixes after the conversion tool. Mostly based on sphinx warnings.
2025-08-06 02:20:01 +02:00
Marek Marczykowski-Górecki
d42b5ce13f
Import attachment repo
Import only files used in the documentation (and their source files if
applicable).
Imported from https://github.com/QubesOS/qubes-attachment at
52bc8a22484236c5bd494707aafe32aa5e849950.
2025-08-06 02:20:01 +02:00
Marek Marczykowski-Górecki
918eaa479d
Convert to RST
This is done using tools at
https://github.com/maiska/qubes-translation-utilz, commit
4c8e2a7f559fd37e29b51769ed1ab1c6cf92e00d.
2025-08-06 02:19:56 +02:00
Marek Marczykowski-Górecki
e14921b8a3
Rename all md files to rst
This is plain rename without changing content, to help git track files
history.
Do not touch files that are going to be removed during conversion.

Thanks @parulin for the idea!
2025-08-06 02:16:04 +02:00
qubedmaiska
e3db139fe3
fixed a tab 2025-07-01 16:12:00 -04:00