Merge pull request #1375 from PrernaSingh587/patch-4

Modification in conda_forge_yml.rst - top level fields list

Author: beckermr

src/maintainer/conda_forge_yml.rst

@@ -21,33 +21,34 @@ upload packages to anaconda.org, which can be useful for testing. For example:
 Top-level fields
 ================
 
-* appveyor
-* azure
-* build_platform
-* bot
-* channel_priority
-* channels
-* choco
-* circle
-* conda_forge_output_validation
-* docker
-* github
-* idle_timeout_minutes
-* linux
-* linux_aarch64
-* linux_ppc64le
-* os_version
-* osx
-* provider
-* recipe_dir
-* remote_ci_setup
-* skip_render
-* templates
-* test_on_native_only
-* travis
-* upload_on_branch
-* win
-
+* :ref:`appveyor`
+* :ref:`azure-config`
+* :ref:`build_platform`
+* :ref:`bot`
+* :ref:`channel_priority`
+* :ref:`channels`
+* :ref:`choco`
+* :ref:`circle`
+* :ref:`conda_forge_output_validation`
+* :ref:`docker`
+* :ref:`github`
+* :ref:`idle_timeout_minutes`
+* :ref:`linux`
+* :ref:`linux_aarch64`
+* :ref:`linux_ppc64le`
+* :ref:`os_version`
+* :ref:`osx`
+* :ref:`provider`
+* :ref:`recipe_dir`
+* :ref:`remote_ci_setup`
+* :ref:`skip_render`
+* :ref:`templates`
+* :ref:`test_on_native_only`
+* :ref:`travis`
+* :ref:`upload_on_branch`
+* :ref:`win`
+
+.. _appveyor:
 
 appveyor
 --------
@@ -78,6 +79,8 @@ mapping for Azure-specific configuration options. For example:
       # built packages) as an Azure pipeline artifact that can be downloaded
       store_build_artifacts: False
 
+.. _bot:
+
 bot
 ---
 This field controls the behavior of the ``auto-tick`` bot which issues
@@ -101,6 +104,8 @@ automatic version updates/migrations for feedstocks. The current options are
       abi_migration_branches:
         - v1.10.x
 
+.. _build_platform:
+
 build_platform
 --------------
 This is a mapping from the build platform to the host platform of the package
@@ -112,13 +117,17 @@ build platform using cross-compiling.
     build_platform:
       osx_64: linux_64
 
+.. _channel_priority:
+
 channel_priority
 ----------------
 
 This value sets the ``conda`` solver channel priority for feedstock builds. 
 The default is ``strict``. Any valid value for the same setting in the ``.condarc`` is
 allowed here.
 
+.. _channels:
+
 channels
 --------
 This represents the channels to grab packages from during builds and
@@ -138,6 +147,7 @@ has been built.  The ``channels`` variable is a mapping with
       targets:
         - ["conda-forge", "main"]
 
+.. _choco:
 
 choco
 -----
@@ -158,6 +168,8 @@ This is currently only implemented for Azure Pipelines. The command that is run
 ``choco install {entry} -fdv -y --debug``.  That is, ``choco install`` is executed
 with a standard set of additional flags that are useful on CI.
 
+.. _circle:
+
 circle
 --------
 The top-level ``circle`` key specifies configurations for the Circle
@@ -171,13 +183,17 @@ modified.  Tools like conda-smithy may modify this, as need.  It has a single
       secure:
         BINSTAR_TOKEN: <some big hash>
 
+.. _conda_forge_output_validation:
+
 conda_forge_output_validation
 -----------------------------
 
 This field must be set to ``True`` for feedstocks in the ``conda-forge`` GitHub
 organization. It enables the required feedstock artifact validation as described
 in :ref:`output_validation`.
 
+.. _docker:
+
 docker
 ------
 This is a mapping to docker configuration options. These are relatively
@@ -191,6 +207,8 @@ self-explanatory. The defaults are as follows:
       command: "bash"
       interactive: True
 
+.. _github:
+
 github
 ------
 This is mapping of configuration variables for GitHub. The
@@ -206,6 +224,7 @@ defaults are as follows:
       # branch name to execute on
       branch_name: master
 
+.. _idle_timeout_minutes:
 
 idle_timeout_minutes
 --------------------
@@ -216,6 +235,7 @@ don't have chatty enough builds. Currently only implemented in Travis and Circle
 
     idle_timeout_minutes: 60
 
+.. _linux:
 
 linux
 -----
@@ -227,6 +247,7 @@ Currently only:
     linux:
       enabled: False
 
+.. _linux_aarch64:
 
 linux_aarch64
 -------------
@@ -238,6 +259,7 @@ Currently only:
     linux_aarch64:
       enabled: False
 
+.. _linux_ppc64le:
 
 linux_ppc64le
 -------------
@@ -249,6 +271,8 @@ Currently only:
     linux_ppc64le:
       enabled: False
 
+.. _os_version:
+
 os_version
 ----------
 This key is used to set the OS versions for ``linux_*`` platforms. Valid entries map a linux platform and arch to either ``cos6``
@@ -259,6 +283,8 @@ or ``cos7``. Currently ``cos6`` is the default for ``linux-64``. All other linux
     os_version:
       linux_64: cos7
 
+.. _osx:
+
 osx
 ---
 The macOSX-specific configuration options. This is largely an internal setting.
@@ -269,6 +295,8 @@ Currently only:
     osx:
       enabled: False
 
+.. _provider:
+
 provider
 --------
 The ``provider`` field is a mapping from arch (operating system) to CI service.
@@ -319,6 +347,8 @@ To enable ``linux_ppc64le`` and ``linux_aarch64`` and the following:
       linux_ppc64le: default
       linux_aarch64: default
 
+.. _recipe_dir:
+
 recipe_dir
 ----------
 The relative path to the recipe directory. The default is:
@@ -327,6 +357,8 @@ The relative path to the recipe directory. The default is:
 
     recipe_dir: recipe
 
+.. _remote_ci_setup:
+
 remote_ci_setup
 ---------------
 This option can be used to override the default ``conda-forge-ci-setup`` package.
@@ -337,6 +369,8 @@ channel_alias if no prefix given.
 
     remote_ci_setup: "conda-forge-ci-setup=3"
 
+.. _skip_render:
+
 skip_render
 -----------
 This option specifies a list of files which conda smithy will skip rendering.
@@ -350,11 +384,15 @@ For example, if you want to customize .gitignore and LICENSE.txt file by your ow
       - .gitignore
       - LICENSE.txt
 
+.. _templates:
+
 templates
 ---------
 This is mostly an internal field for specifying where templates files live.
 You shouldn't need it.
 
+.. _test_on_native_only:
+
 test_on_native_only
 -------------------
 This is used for disabling testing for cross compiling. Default is ``false``
@@ -363,6 +401,8 @@ This is used for disabling testing for cross compiling. Default is ``false``
 
     test_on_native_only: True
 
+.. _travis:
+
 travis
 ------
 The top-level ``travis`` key specifies configurations for the Travis
@@ -376,6 +416,8 @@ modified.  Tools like conda-smithy may modify this, as need.  It has a single
       secure:
         BINSTAR_TOKEN: <some big hash>
 
+.. _upload_on_branch:
+
 upload_on_branch
 ----------------
 This parameter restricts uploading access on work from certain branches of the
@@ -388,6 +430,8 @@ master branch:
 
     upload_on_branch: master
 
+.. _win:
+
 win
 ---
 The Windows-specific configuration options. This is largely an internal setting.