Add more svn scenario's to the documentation

Author: spoorcc

dfetch/commands/check.py

@@ -5,7 +5,15 @@
 
 .. uml:: /static/uml/check.puml
 
-.. scenario-include:: ../features/check-git-repo.feature
+.. tabs::
+
+   .. tab:: Git
+
+      .. scenario-include:: ../features/check-git-repo.feature
+
+   .. tab:: SVN
+
+      .. scenario-include:: ../features/check-svn-repo.feature
 
 Child-manifests
 ~~~~~~~~~~~~~~~

dfetch/commands/diff.py

@@ -19,7 +19,15 @@
 
    dfetch diff some-project
 
-.. scenario-include:: ../features/diff-in-git.feature
+.. tabs::
+
+   .. tab:: Git
+
+      .. scenario-include:: ../features/diff-in-git.feature
+
+   .. tab:: SVN
+
+      .. scenario-include:: ../features/diff-in-svn.feature
 
 Using the generated patch
 =========================
@@ -29,13 +37,19 @@
 The generated patch is a relative patch and should be by applied specifying the base directory of the *git repo*.
 See below for the version control specifics. The patch will also contain the content of binary files.
 
-.. code-block:: sh
+.. tabs::
 
-   # For git repo's
-   git apply --verbose --directory='some-project' some-project.patch
+    .. tab:: Git
+
+        .. code-block:: sh
+
+            git apply --verbose --directory='some-project' some-project.patch
+
+    .. tab:: SVN
+
+        .. code-block:: sh
 
-   # For svn repo's
-   svn patch some-project.patch
+            svn patch some-project.patch
 
 .. warning::
 

dfetch/commands/update.py

@@ -5,7 +5,15 @@
 
 .. uml:: /static/uml/update.puml
 
-.. scenario-include:: ../features/fetch-git-repo.feature
+.. tabs::
+
+   .. tab:: Git
+
+      .. scenario-include:: ../features/fetch-git-repo.feature
+
+   .. tab:: SVN
+
+      .. scenario-include:: ../features/fetch-svn-repo.feature
 
 Child-manifests
 ~~~~~~~~~~~~~~~

dfetch/manifest/project.py

@@ -142,7 +142,15 @@
           src: src/*.h
           repo-path: cpputest/cpputest
 
-.. scenario-include:: ../features/fetch-file-pattern-git.feature
+.. tabs::
+
+   .. tab:: Git
+
+      .. scenario-include:: ../features/fetch-file-pattern-git.feature
+
+   .. tab:: SVN
+
+      .. scenario-include:: ../features/fetch-file-pattern-svn.feature
 
 Ignore
 ######
@@ -172,7 +180,15 @@
           And the ignores will be applied *after* the ``src:`` pattern was applied.
           License files will never be excluded, since you likely shouldn't be doing that.
 
-.. scenario-include:: ../features/fetch-with-ignore-git.feature
+.. tabs::
+
+   .. tab:: Git
+
+      .. scenario-include:: ../features/fetch-with-ignore-git.feature
+
+   .. tab:: SVN
+
+      .. scenario-include:: ../features/fetch-with-ignore-svn.feature
 
 VCS type
 ########
@@ -226,23 +242,31 @@
           repo-path: cpputest/cpputest
           patch: local_changes.patch
 
-The patch can be generated using the *Dfetch* :ref:`Diff` command.
-Alternately the patch can be generated manually as such. Note that it should be *relative*.
+The patch should be generated using the *Dfetch* :ref:`Diff` command.
+Alternately the patch can be generated manually as such.
+Note that the patch should be *relative* to the projects root.
+
+.. tabs::
+
+    .. tab:: Git
+
+        .. code-block:: sh
+
+            git diff --relative=path/to/project HEAD > my_patch.patch
+
+        For more details see the `git-diff <https://git-scm.com/docs/git-diff>`_ documentation.
 
-.. code-block:: sh
+        .. scenario-include:: ../features/diff-in-git.feature
 
-    # For git repo's
-    git diff --relative=path/to/project HEAD > my_patch.patch
+    .. tab:: SVN
 
-    # For svn repo's
-    svn diff -r HEAD path/to/my_project > my_patch.patch
+        .. code-block:: sh
 
-For more details see the `git-diff`_ or `svn-diff`_ documentation.
+            svn diff -r HEAD path/to/my_project > my_patch.patch
 
-.. _`git-diff`: https://git-scm.com/docs/git-diff
-.. _`svn-diff`: http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.diff.html
+        For more details see the `svn-diff <http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.diff.html>`_ documentation.
 
-.. scenario-include:: ../features/diff-in-git.feature
+        .. scenario-include:: ../features/diff-in-svn.feature
 
 """
 

doc/conf.py

@@ -39,6 +39,7 @@
     "sphinxcontrib.details.directive",
     "sphinx-jsonschema",
     "sphinxcontrib.programoutput",
+    "sphinx_tabs.tabs",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

pyproject.toml

@@ -97,6 +97,7 @@ docs = [
     'sphinx-sitemap==2.9.0',
     'sphinx-jsonschema==1.19.2',
     'sphinxcontrib-programoutput==0.18',
+    'sphinx-tabs==3.4.7',
 ]
 test = ['pytest==8.4.2', 'pytest-cov==7.0.0', 'behave==1.3.3']
 casts = ['asciinema==2.4.0']