Convert all the documentation to Sphinx / RST - final version

.gitignore

@@ -0,0 +1,4 @@
+_build
+**/__pycache__/*
+uv.lock
+poetry.lock

.readthedocs.yaml

@@ -0,0 +1,25 @@
+version: 2
+
+build:
+  os: "ubuntu-lts-latest"
+  tools:
+    python: "3.13"
+
+submodules:
+  include: all
+  recursive: true
+
+sphinx:
+  builder: html
+  configuration: conf.py
+  fail_on_warning: false
+
+python:
+  install:
+   - requirements: requirements.txt
+
+formats:
+- pdf
+- epub
+
+

CONTRIBUTING.md

@@ -2,11 +2,11 @@
 
 Thank you for your interest in contributing to `qubes-doc`, the Qubes OS
 Project's dedicated documentation repository! Please see [how to edit the
-documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/) for
+documentation](https://doc.qubes-os.org/developer/general/how-to-edit-the-rst-documentation.html) for
 detailed contribution instructions.
 
 In addition, please take a moment to read our [documentation style
-guide](https://www.qubes-os.org/doc/documentation-style-guide/) before
+guide](https://doc.qubes-os.org/developer/general/rst-documentation-style-guide.html) before
 contributing. These guidelines are important to maintaining high standards of
 quality, and following them will increase the likelihood that your contribution
 will be accepted.

README.md

@@ -1,11 +1,11 @@
 # Qubes OS Documentation
 
-Canonical URL: https://www.qubes-os.org/doc/
+Canonical URL: https://doc.qubes-os.org
 
 All [Qubes OS Project](https://github.com/QubesOS) documentation pages are
-stored as plain text files in this dedicated repository. By cloning and
+stored as plain reStructuredText files in this dedicated repository. By cloning and
 regularly pulling from this repo, users can maintain their own up-to-date
 offline copy of all Qubes documentation rather than relying solely on the Web.
 
 To contribute, please see [how to edit the
-documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/).
+documentation](https://doc.qubes-os.org/developer/general/how-to-edit-the-rst-documentation.html).

_dev/index.rst

@@ -1,9 +1,29 @@
+==============================================
 Welcome to Qubes OS developer's documentation!
 ==============================================
 
+
 This is documentation for the source code. Please choose specific repostitory:
 
-* `core-admin </projects/core-admin>`_
-* `core-admin-client </projects/core-admin-client>`_
+.. toctree::
+   :maxdepth: 1
+
+   core-admin <>
+.. _core-admin: /projects/core-admin
+
+
+
+   core-admin-client <>
+.. _core-admin-client: /projects/core-admin-client
+
+
+
+   qubes-core-qrexec <>
+.. _qubes-core-qrexec: /projects/qubes-core-qrexec
+
+
+
+Or see the main Qubes OS documentation <https://www.qubes-os.org/doc/>
+.. _the main qubes os documentation: https://www.qubes-os.org/doc/
 
-Or see `the main Qubes OS documentation <https://www.qubes-os.org/doc/>`_.
+.

_ext/youtube_frame.py

@@ -0,0 +1,68 @@
+"""
+    ReST directive for embedding Youtube and Vimeo videos.
+
+    There are two directives added: ``youtube`` and ``vimeo``. The only
+    argument is the video id of the video to include.
+    Both directives have three optional arguments: ``height``, ``width``
+    and ``align``. Default height is 281 and default width is 500.
+
+    Example::
+
+        .. youtube:: anwy2MPT5RE
+           :height: 315
+           :width: 560
+           :align: left
+
+    :copyright: (c) 2012 by Danilo Bargen.
+    :license: BSD 3-clause
+
+    From https://gist.github.com/ehles/bed012d78aad5d3cd6c35a49bef32f9f
+"""
+from __future__ import absolute_import
+from docutils import nodes
+from docutils.parsers.rst import Directive, directives
+
+def align(argument):
+    """Conversion function for the "align" option."""
+    return directives.choice(argument, ('left', 'center', 'right'))
+
+
+class IframeVideo(Directive):
+    has_content = False
+    required_arguments = 1
+    optional_arguments = 0
+    final_argument_whitespace = False
+    option_spec = {
+        'height': directives.nonnegative_int,
+        'width': directives.nonnegative_int,
+        'align': align,
+    }
+    default_width = 500
+    default_height = 281
+
+    def run(self):
+        self.options['video_id'] = directives.uri(self.arguments[0])
+        if not self.options.get('width'):
+            self.options['width'] = self.default_width
+        if not self.options.get('height'):
+            self.options['height'] = self.default_height
+        if not self.options.get('align'):
+            self.options['align'] = 'left'
+        return [nodes.raw('', self.html % self.options, format='html')]
+
+
+class GeneralVid(IframeVideo):
+    html = '<iframe src="%(video_id)s" width="%(width)u" height="%(height)u" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowfullscreen class="responsive" referrerpolicy="no-referrer" scrolling="no"></iframe>'
+
+
+class Youtube(IframeVideo):
+    html = '<iframe src="https://www.youtube-nocookie.com/embed/%(video_id)s" \
+    width="%(width)u" height="%(height)u" frameborder="0" \
+    webkitAllowFullScreen mozallowfullscreen allowfullscreen \
+    class="responsive" referrerpolicy="no-referrer" scrolling="no"></iframe>'
+
+
+def setup(builder):
+    directives.register_directive('youtube', Youtube)
+    directives.register_directive('generalvid', GeneralVid)
+