Skip to content

Conversation

@parulin
Copy link
Contributor

@parulin parulin commented Aug 9, 2025

All raw directives have been removed or replaced by reStructuredText list-tables.

Thanks @tokideveloper

Original PR: #1502

@maiska maiska self-requested a review August 10, 2025 09:05
@maiska
Copy link
Contributor

maiska commented Aug 16, 2025

@parulin would you update yout branch to the state of current rst branch or should I?

marmarek and others added 17 commits August 16, 2025 14:22
RTD provides own CI service
* 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
* Avoid checking .onion domains.
* Do not download links to check anchors
* reuse html builder
* rename videos extension to youtube_frame
* remove HTML body max/min parameters
* remove reference to release number in HTML title
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`.
* 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
@parulin
Copy link
Contributor Author

parulin commented Aug 16, 2025

Oh no! I made a mistake :[

@parulin parulin force-pushed the paragraphs-workaround-2 branch 2 times, most recently from 1154873 to 6d9913d Compare August 16, 2025 19:14
@parulin
Copy link
Contributor Author

parulin commented Aug 16, 2025

Is that sufficiently correct? :/

@parulin parulin force-pushed the paragraphs-workaround-2 branch from c38ab11 to 12ffcb3 Compare August 16, 2025 19:43
@maiska
Copy link
Contributor

maiska commented Aug 17, 2025

Qubes builder looks weird, but I can have a though look at it when reviewing :) Thank you

Fixing a previous mistake.
I previously erased these edits ...
This restores a82da5b
@parulin parulin force-pushed the paragraphs-workaround-2 branch from 12ffcb3 to 08672d4 Compare August 18, 2025 07:20


1. for Fedora, use:
2. **Installing dependencies**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the emphasis since this is a style change not really consistent with the rest of the document(ation)

@maiska maiska merged commit d05bb2b into QubesOS:rst Aug 27, 2025
1 check passed
@parulin parulin deleted the paragraphs-workaround-2 branch August 31, 2025 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants