From 76cbcdb92f2c07e1f958cb1b224021e7afc970a5 Mon Sep 17 00:00:00 2001 From: Pavel Raiskup Date: Jun 17 2019 07:14:48 +0000 Subject: doc: fix another set of toctree warnings Convert some manual menus to toctree, put some more pages on toctree list; and on the pages where it doesn't make sense to hack on toctree integration use ':orphan:' to silence the warnings. /home/praiskup/rh/projects/copr/copr/doc/beaker_tests.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/building_package.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/contribute.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/copr_outdated_chroots_removal_policy.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/custom_source_method.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/git_guide.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/how_to_enable_repo.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/how_to_install.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/patch_process.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/screenshots_tutorial.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/src_rpm_upload.rst: WARNING: document isn't included in any toctree /home/praiskup/rh/projects/copr/copr/doc/webhook_hacking.rst: WARNING: document isn't included in any toctree --- diff --git a/doc/copr_outdated_chroots_removal_policy.rst b/doc/copr_outdated_chroots_removal_policy.rst index 8681ebb..f7f7488 100644 --- a/doc/copr_outdated_chroots_removal_policy.rst +++ b/doc/copr_outdated_chroots_removal_policy.rst @@ -1,3 +1,5 @@ +:orphan: + .. _copr_outdated_chroots_removal_policy: Outdated chroots removal policy diff --git a/doc/custom_source_method.rst b/doc/custom_source_method.rst index 2093b25..3c6274f 100644 --- a/doc/custom_source_method.rst +++ b/doc/custom_source_method.rst @@ -1,3 +1,5 @@ +:orphan: + .. _custom_source_method: Custom source method diff --git a/doc/developer_documentation.rst b/doc/developer_documentation.rst index 724366d..b7113c3 100644 --- a/doc/developer_documentation.rst +++ b/doc/developer_documentation.rst @@ -16,19 +16,16 @@ Copr comes in several pieces. You can browse the source here: Working with the code --------------------- -* :ref:`how_to_install` How to Install - Copr is intended as service. You most likely do not want to set up your own instance. But if you really want to, Copr set up is documented here. - -* :ref:`contribute` How to Contribute - Do you want to help us? Start here. - -* :ref:`git_guide` Git Guide -- how to work with Git, the source control of choice for Copr - -* :ref:`patch_process` -- how to go about creating a new patch and submitting it to the mailing list - -* :ref:`building_package` -- how to build Copr itself - -* `Database schema `_ - -* `Documentation of python code `_ - most up-to-date documentation are in copr-frontend-doc and copr-backend-doc packages. +.. toctree:: + :maxdepth: 1 + + How to install Copr as build service + Contribution, do you want to help us? + How to work with Git (the version control system for Copr project) + Do you prefer sending patches? + Building Copr packages (backend, frontend, ...) + Database schema + Documentation of python code (or check copr-frontend-doc.rpm and copr-backend-doc.rpm) History ------- diff --git a/doc/how_to_enable_repo.rst b/doc/how_to_enable_repo.rst index 4d8707b..e8e6251 100644 --- a/doc/how_to_enable_repo.rst +++ b/doc/how_to_enable_repo.rst @@ -1,3 +1,5 @@ +:orphan: + .. _how_to_enable_repo: How to enable repo diff --git a/doc/maintenance_documentation.rst b/doc/maintenance_documentation.rst index e5dda0e..64dc3c9 100644 --- a/doc/maintenance_documentation.rst +++ b/doc/maintenance_documentation.rst @@ -14,4 +14,5 @@ This section contains information about maintenance topics. You may also be inte How to manage active chroots Sending notifications and removing data from outdated chroots sanity_tests + beaker_tests seeddb diff --git a/doc/screenshots_tutorial.rst b/doc/screenshots_tutorial.rst index 04d503b..71bc8e1 100644 --- a/doc/screenshots_tutorial.rst +++ b/doc/screenshots_tutorial.rst @@ -1,3 +1,5 @@ +:orphan: + .. _screenshots_tutorial: Screenshots tutorial diff --git a/doc/src_rpm_upload.rst b/doc/src_rpm_upload.rst index 840c44b..b948ee5 100644 --- a/doc/src_rpm_upload.rst +++ b/doc/src_rpm_upload.rst @@ -1,3 +1,5 @@ +:orphan: + .. _SrcRpmUpload: Upload of src.rpm diff --git a/doc/user_documentation.rst b/doc/user_documentation.rst index 9e6f091..13c52cb 100644 --- a/doc/user_documentation.rst +++ b/doc/user_documentation.rst @@ -26,6 +26,10 @@ Tutorial See :ref:`screenshots_tutorial` for interacting with `copr.fedoraproject.org `_ + +How to enable copr repository? +------------------------------ + :ref:`how_to_enable_repo` Build Source Types diff --git a/doc/webhook_hacking.rst b/doc/webhook_hacking.rst index b25f364..ffcecad 100644 --- a/doc/webhook_hacking.rst +++ b/doc/webhook_hacking.rst @@ -1,3 +1,5 @@ +:orphan: + .. _webhook_hacking: COPR auto-rebuilds with custom Git repositories