Move docs advanced topics into new subsection

Currently everything is in one level when you open the Anaconda documentation. There is a lot of topics. Let's make the documentation a bit more structured. Adding developer directory but also a page with this content so it is more hidden.
rhinstaller · Dec 20, 2024 · 58715e2 · 58715e2
1 parent 7dcf035
commit 58715e2
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 11 deletions.
diff --git a/docs/developer.rst b/docs/developer.rst
@@ -0,0 +1,20 @@
+Developer documentation
+=======================
+
+Here are topics which are covering mostly advanced topics to help users to modify Anaconda and understand the code.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   developer/commit-log
+   developer/configuration-files
+   developer/driverdisc
+   developer/iscsi
+   developer/mount-points
+   developer/multipath
+   developer/sysconfig-file
+   developer/drop-in-scripts
+   Testing <developer/testing>
+
diff --git a/docs/commit-log.rst → docs/developer/commit-log.rst b/docs/commit-log.rst → docs/developer/commit-log.rst
diff --git a/docs/configuration-files.rst → docs/developer/configuration-files.rst b/docs/configuration-files.rst → docs/developer/configuration-files.rst
diff --git a/docs/driverdisc.rst → docs/developer/driverdisc.rst b/docs/driverdisc.rst → docs/developer/driverdisc.rst
diff --git a/docs/drop-in-scripts.rst → docs/developer/drop-in-scripts.rst b/docs/drop-in-scripts.rst → docs/developer/drop-in-scripts.rst
diff --git a/docs/iscsi.rst → docs/developer/iscsi.rst b/docs/iscsi.rst → docs/developer/iscsi.rst
diff --git a/docs/mount-points.rst → docs/developer/mount-points.rst b/docs/mount-points.rst → docs/developer/mount-points.rst
diff --git a/docs/multipath.rst → docs/developer/multipath.rst b/docs/multipath.rst → docs/developer/multipath.rst
diff --git a/docs/sysconfig-file.rst → docs/developer/sysconfig-file.rst b/docs/sysconfig-file.rst → docs/developer/sysconfig-file.rst
diff --git a/docs/testing.rst → docs/developer/testing.rst b/docs/testing.rst → docs/developer/testing.rst
@@ -1,5 +1,5 @@
 
-.. include:: ../tests/README.rst
+.. include:: ../../tests/README.rst
 
 What to do if there are broken Rawhide dependencies
 ===================================================
@@ -38,7 +38,7 @@ Cleanup old repository.
     $ ssh <fedora_username>:fedorapeople.org
     $ cd /project/anaconda/repos/anaconda_fixup_repo/
     $ rm -rv *  # to remove the old directory structure
-    
+
 
 Create your repository locally and upload that.
 ::

diff --git a/docs/index.rst b/docs/index.rst
@@ -15,18 +15,10 @@ Contents:
    release-notes
    boot-options
    kickstart
-   configuration-files
    How to report a bug <reporting>
    common-bugs
    How to contribute <contributing>
-   commit-log
    release
-   driverdisc
-   iscsi
-   multipath
    list-harddrives
-   drop-in-scripts
-   sysconfig-file
-   mount-points
-   Testing <testing>
+   developer
    ci-status