qubedmaiska
04d278b0a4
Merge remote-tracking branch 'parulin/intersphinx'
2025-09-21 13:10:09 -04:00
parulin
5fd9a6b52f
Remove garbage content introduced with intersphinx
2025-09-21 11:48:12 -04:00
Marek Marczykowski-Górecki
6d0aeb3570
Update 4.3 release schedule
2025-09-19 17:43:54 +02:00
Solène Rapenne
a595faa4e6
Merge branch 'pr/1522'
2025-09-19 14:32:46 +02:00
parulin
12f2c7a9bd
Fix minor typo on "how-to edit the rst doc..."
...
Fix the "reStrucutredText" words. That's a good example on why it is
better not to label link when possible :)
There is other minor typos and inconsitencies (RST instead of rST).
2025-09-15 04:14:19 -04:00
parulin
f0709dd483
Fix minor typos and link on rst related pages
2025-09-13 17:35:21 -04:00
parulin
47252ef12e
Merge remote-tracking branch 'origin/main' into intersphinx
2025-09-13 17:26:08 -04:00
parulin
1a47fc973b
Add intersphinx documentation and clean syntax
...
* I replaced the `:external:` syntax by a cleaner one, as suggested by
@maiska.
* An implicit external reference is now impossible.
* Fix duplicate labels warnings
* Minor typos, including the word "orthographicallly" :)
2025-09-13 17:18:52 -04:00
qubedmaiska
d9a6e20f3a
add labeling of sections inside rst docs
2025-09-13 11:16:12 -04:00
qubedmaiska
0f77371239
add screenshots with main branch, remove obsolete images, references to main branch instead of rst for conf.py, .readthedocs.yml, attachment, _ext, use .venv
2025-09-13 09:42:04 -04:00
parulin
c40c0ac302
Install intersphinx extension and edit links
...
Some anchor links are currently lost on:
* developer/system/template-manager.rst
* user/how-to-guides/how-to-enter-fullscreen-mode.rst
2025-09-13 04:37:05 -04:00
qubedmaiska
0bf898475f
fix references, refactor website style doc and others
2025-09-09 23:30:17 -04:00
qubedmaiska
bd26dee6a4
add info about readthedocs.yml, exchange code-block with code to be consistent
2025-09-09 12:15:52 -04:00
qubedmaiska
1be6e5f9b9
fixed linter warnings
2025-09-09 12:05:31 -04:00
qubedmaiska
e93ddb3796
fixed reference errors, minor enhancements to the docs, fix pyproject.toml, alt text to images
2025-09-09 11:39:34 -04:00
qubedmaiska
4404a5d5f5
merge upstream rst, add screenshots, rewrite how-to-edit-the-website, combine website and markdown-style-guide, enhance how-to-edit-the-rst-documentation and rst style guide, fix errors, added comments to conf.py, links to README & CONTRIBUTING
2025-09-09 05:29:19 -04:00
qubedmaiska
bb4a0b720f
merge upstream and add rst version of the how to edit Markdown and Markdown and website style guide docs
2025-09-08 02:03:08 -04:00
qubedmaiska
7172de20be
WIP, add screenshots, tips&tricks, rename old documentation
2025-09-08 01:57:27 -04:00
qubedmaiska
4d3109bfc2
Add rst files about how to edit the documentation, documentatioon and website style guide in Markdown
2025-09-08 01:24:47 -04:00
qubedmaiska
6ecfe972a1
merge PR #1494 and fixed conflicts
2025-09-06 07:03:33 -04:00
parulin
8436e2ac9f
Create a real Sphinx glossary
2025-09-06 12:09:48 +02:00
qubedmaiska
ff68e782c8
Merge branch 'code_block_prompts_full' into rst
2025-09-06 06:04:30 -04:00
qubedmaiska
6218ea2dce
Merge remote-tracking branch 'parulin/warning-fix' into rst
2025-09-06 05:42:29 -04:00
Ali Mirjamali
bb5054c462
Initialize asyncio event loop before using it
...
Python 3.14 (in Fedora 43) throws RunetimeError if event loop is not
initialized before using it.
Resolves : QubesOS/qubes-issues#10188
2025-08-27 21:34:24 +03:30
qubedmaiska
d05bb2b25b
merge changes from pr #1508 excluding admin-api (only spaces in diff)
2025-08-27 00:33:39 -04:00
parulin
11b2626fa2
Merge branch 'rst' into paragraphs-workaround-2
2025-08-26 05:50:29 +00:00
parulin
b02eba099e
Fix of tables options and emphasis
2025-08-26 01:43:59 -04:00
qubedmaiska
7e76afb1a4
Fixes to code block pygemnt's highlighting, add __pychache__ to gitignore
...
add prompts to terminal sessions where needed
2025-08-23 18:50:45 -04:00
Tobias Killer
3e683cda68
Add newlines where present in Markdown version
2025-08-23 11:31:46 +02:00
Tobias Killer
140789e7fc
Merge branch 'rst' into toki_fix_findings
2025-08-23 11:05:37 +02:00
qubedmaiska
44dbd11d12
Merge remote-tracking branch 'alimirjamali/issue-10070-r4_3-release-notes' into rst
2025-08-22 17:38:36 -04:00
Ali Mirjamali
d0f91e88db
Qubes OS r4.3 release notes
...
resolves: https://github.com/QubesOS/qubes-issues/issues/10070
2025-08-22 20:17:30 +03:30
parulin
06c6503932
Fixing various warnings from sphinx-build
...
* missing theme options in conf.py
* orphaned pages are tagged as such
* a markup mistake
* duplicate labels
* a code-block marked as python code
2025-08-18 16:52:34 -04:00
parulin
41fae0f5a4
Use :menuselection: when appropriate
2025-08-18 16:26:35 -04:00
parulin
dbbed6af86
Restoring Fedora and Debian instructions
...
Fixing a previous mistake.
2025-08-18 03:10:23 -04:00
qubedmaiska
def5eec5c9
Extract session comments into instructions
2025-08-16 14:23:13 -04:00
qubedmaiska
43493b38e6
Add prompts to all code blocks with bash session
2025-08-16 14:23:09 -04:00
parulin
651229c10d
Change again some languages
...
Thanks to @tokideveloper !!!
2025-08-16 14:23:06 -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
4fa0d293bd
Remove duplicate captions and wrong alt formatting of images
2025-08-16 14:22:17 -04:00
Tobias Killer
cad541c3af
Merge branch 'rst' into toki_fix_findings
2025-08-16 20:05:30 +02:00
qubedmaiska
e3e699fa5e
Extract session comments into instructions
2025-08-16 09:31:12 -04:00
qubedmaiska
367d5ca10f
Add initial How to edit the rst documentation and rst documentaion style guide docs
2025-08-15 17:26:56 -04:00
qubedmaiska
2d2bcb06a6
Add prompts to all code blocks with bash session
2025-08-15 16:49:01 -04:00
qubedmaiska
d4e09e079f
Merge remote-tracking branch 'parulin/clean-code-block-console' into rst
2025-08-15 13:57:46 -04:00
parulin
c5a053d12e
Fix missing cell in table
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
