Skip to content

Commit 2c658b8

Browse files
authored
Merge pull request #1561 from croth1/fix_warnings
2 parents 4a69be5 + 368a49e commit 2c658b8

File tree

7 files changed

+79
-76
lines changed

7 files changed

+79
-76
lines changed

src/maintainer/adding_pkgs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ There are multiple ways to get started:
2929
Then if necessary, you can make manual edits to the recipe.
3030
#. If it is a python package, you can generate the recipe as a starting point with ``grayskull``.
3131
Use ``conda install -c conda-forge grayskull`` to install ``grayskull``, followed by ``grayskull pypi your_package_name`` to generate the recipe. Note that you do *not* necessarily have to use ``grayskull``, and the
32-
recipes produced by ``grayskull`` might need to be reviewed and edited. Read more about ``grayskull`` and how to use it `here <https://github.com/conda-incubator/grayskull#introduction>`_.
32+
recipes produced by ``grayskull`` might need to be reviewed and edited. Read more about ``grayskull`` and how to use it `here <https://github.com/conda-incubator/grayskull#introduction>`__.
3333

3434
Your final recipe should have no comments (unless they're actually relevant to the recipe, and not generic instruction comments), and follow the order in the example.
3535

src/maintainer/conda_forge_yml.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Leaving this field empty implicitly requests to build a package natively. i.e.
152152
.. _build_with_mambabuild:
153153

154154
build_with_mambabuild
155-
--------------
155+
---------------------
156156
This option, when enabled, configures the conda-forge CI to run a debug build using the ``mamba`` solver. Check `this <https://conda-forge.org/docs/maintainer/maintainer_faq.html#mfaq-mamba-local>`__ to know more.
157157

158158
.. code-block:: yaml
@@ -457,17 +457,19 @@ This is used for disabling testing for cross compiling. Default is ``false``
457457
.. _test:
458458

459459
test
460-
-------------------
460+
----
461461
This is used to configure on which platforms a recipe is tested. Default is ``all``.
462462

463463
.. code-block:: yaml
464464
465465
test: native_and_emulated
466+
466467
Will do testing only if the platform is native or if there is an emulator.
467468

468469
.. code-block:: yaml
469470
470471
test: native
472+
471473
Will do testing only if the platform is native.
472474

473475
.. _travis:

src/maintainer/infrastructure.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Repositories
99
Staging area for recipes
1010
------------------------
1111

12-
`conda-forge/staged-recipes <https://github.com/conda-forge/staged-recipes>`_ is the entry point for new packages to join the conda-forge package collection.
12+
`conda-forge/staged-recipes <https://github.com/conda-forge/staged-recipes>`__ is the entry point for new packages to join the conda-forge package collection.
1313
You can find the detailed guide for submitting new package recipes in :ref:`creating_recipes`.
1414

1515
Smithy
@@ -25,23 +25,23 @@ Smithy contains maintenance code for conda-forge, which is used by the ``conda-s
2525

2626
``conda-smithy`` also contains the command line tool that you should use if you rerender manually from the command line (see :ref:`dev_update_rerender`).
2727

28-
Smithy can be used beyond Conda-Forge's purposes. For example, it can be used to `set up self-hosted Azure agents <self-hosted_azure-config>`_ for non-Conda-Forge infrastructures.
28+
Smithy can be used beyond Conda-Forge's purposes. For example, it can be used to `set up self-hosted Azure agents <self-hosted_azure-config>`__ for non-Conda-Forge infrastructures.
2929
(You could also consider using `Azure virtual machine scale set agents <https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/scale-set-agents?view=azure-devops>`_,
3030
which could be less expensive to run than permanently active agents.)
3131

3232

3333
Web services
3434
------------
3535

36-
The Heroku app providing the conda-forge web services lives in `conda-forge/conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
36+
The Heroku app providing the conda-forge web services lives in `conda-forge/conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`__.
3737
Please note that the code logic provided by the app is in the ``Smithy`` repository.
3838

39-
Bugs or suggestions regarding the service functionality should therefore be opened in ``conda-forge/conda-smithy``'s `bug tracker <https://github.com/conda-forge/conda-smithy/issues>`_.
39+
Bugs or suggestions regarding the service functionality should therefore be opened in ``conda-forge/conda-smithy``'s `bug tracker <https://github.com/conda-forge/conda-smithy/issues>`__.
4040

4141
conda-forge pinning
4242
-------------------
4343

44-
Package-wide dependency pins are defined in `conda_build_config.yaml <https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/conda_build_config.yaml>`_ in the `conda-forge/conda-forge-pinning-feedstock <https://github.com/conda-forge/conda-forge-pinning-feedstock>`_.
44+
Package-wide dependency pins are defined in `conda_build_config.yaml <https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/conda_build_config.yaml>`__ in the `conda-forge/conda-forge-pinning-feedstock <https://github.com/conda-forge/conda-forge-pinning-feedstock>`_.
4545

4646
For more information on conda-forge wide package pins, please refer to :ref:`globally_pinned_packages`.
4747

@@ -129,7 +129,7 @@ associated with the repo. This command can be useful for people who are not yet
129129
so cannot @-mention the ``staged-recipes`` team for PR reviews.
130130

131131
@conda-forge-admin, please ping conda-forge/<team>
132-
------------------------------------
132+
--------------------------------------------------
133133

134134
Entering this command in the PR of a feedstock or staged-recipes will have the admin bot @-mention the respective team.
135135
This command can be useful for people who are not yet members of conda-forge and
@@ -148,7 +148,7 @@ Adding this label to non-bot issued PRs will have no effect.
148148
Entering this command in the title or comment of an issue will instruct the admin bot to
149149
open a PR enabling the automatic merging of passing PRs from the ``auto-tick``
150150
bot. This functionality is currently experimental. You can find more details
151-
`here <https://regro.github.io/cf-scripts/github_actions_infrastructure.html#automerging-prs>`_.
151+
`here <https://regro.github.io/cf-scripts/github_actions_infrastructure.html#automerging-prs>`__.
152152
Please open issue on ``regro/cf-scripts`` for any feedback, bugs, and/or questions!
153153

154154
@conda-forge-admin, please add python 2.7
@@ -162,7 +162,7 @@ other builds. **Python 2.7 support is deprecated and any feedstocks on Python 2.
162162
not be properly handled by our bots.**
163163

164164
@conda-forge-admin, please add user @username
165-
--------------------------------------
165+
---------------------------------------------
166166

167167
Entering the above phrase in the title of an issue on a feedstock will make a PR
168168
that adds the given user to the feedstock. A maintainer or member of ``core`` can then merge
@@ -181,7 +181,7 @@ Azure is used to build packages for OSX, Linux (x86_64, native), Linux (ARMv8, e
181181
The build queue on Azure is substantially larger than on all the other providers.
182182
Azure builds have a maximum duration of 6 hours.
183183

184-
To see all builds on Azure, visit `<https://dev.azure.com/conda-forge/feedstock-builds/_build>`_.
184+
To see all builds on Azure, visit `<https://dev.azure.com/conda-forge/feedstock-builds/_build>`__.
185185

186186
Restarting builds
187187
.................
@@ -226,7 +226,7 @@ Enable a build by adding the following to ``conda-forge.yml`` in the root of the
226226
osx: travis
227227
228228
For IBM Power 8+ builds, add the name of your feedstock to the list `here
229-
<https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/migrations/arch_rebuild.txt>`_
229+
<https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/migrations/arch_rebuild.txt>`__
230230
via a pull request.
231231

232232

@@ -259,8 +259,8 @@ Enabling Circle on your Fork
259259

260260
If for some reason CircleCI is not triggering build from forks,
261261
Circle can be manually added for each fork. Circle calls this "Adding a Project" and
262-
`the official CircleCI documentation is available here <https://circleci.com/docs/getting-started/#add-and-follow-more-projects>`_.
263-
This effectively amounts to going to the `Add Projects <https://circleci.com/add-projects>`_
262+
`the official CircleCI documentation is available here <https://circleci.com/docs/getting-started/#add-and-follow-more-projects>`__.
263+
This effectively amounts to going to the `Add Projects <https://circleci.com/add-projects>`__
264264
page, finding the fork that you wish to enable, and clicking the "Build Project" button.
265265
This is not normally needed.
266266

@@ -271,7 +271,7 @@ If CircleCI lacks permissions to checkout the source code, it will produce an er
271271
Permission denied (publickey).
272272
fatal: Could not read from remote repository.
273273

274-
When this happens for a feedstock, it can be fixed using the `webservice <https://conda-forge.org/docs/webservice.html#conda-forge-admin-please-update-circle>`_, by posting the following comment::
274+
When this happens for a feedstock, it can be fixed using the `webservice <https://conda-forge.org/docs/webservice.html#conda-forge-admin-please-update-circle>`__, by posting the following comment::
275275

276276
@conda-forge-admin, please update circle
277277

@@ -285,7 +285,7 @@ Otherwise (e.g. in a PR to staged-recipes), here are some things you can try:
285285
Drone.io
286286
--------
287287

288-
We use `Drone.io <https://drone.io>`_ for Linux ARMv8 builds. To enable these builds on your feedstock, make a pull request to add your feedstock to the list
288+
We use `Drone.io <https://drone.io>`__ for Linux ARMv8 builds. To enable these builds on your feedstock, make a pull request to add your feedstock to the list
289289
here `<https://github.com/conda-forge/conda-forge-pinning-feedstock/blob/master/recipe/migrations/arch_rebuild.txt>`_.
290290

291291

@@ -298,9 +298,9 @@ GitHub Actions.
298298
Automerge
299299
.........
300300

301-
The automerge service uses the GitHub action in this `repo <https://github.com/conda-forge/automerge-action>`_. This action runs out of a
302-
Docker `container <https://hub.docker.com/repository/docker/condaforge/automerge-action>`_ on the ``prod`` tag. See the
303-
repo `README.md <https://github.com/conda-forge/automerge-action#readme>`_ for more details. PRs are automatically merged if they satisfy either
301+
The automerge service uses the GitHub action in this `repo <https://github.com/conda-forge/automerge-action>`__. This action runs out of a
302+
Docker `container <https://hub.docker.com/repository/docker/condaforge/automerge-action>`__ on the ``prod`` tag. See the
303+
repo `README.md <https://github.com/conda-forge/automerge-action#readme>`__ for more details. PRs are automatically merged if they satisfy either
304304
of the two following sets of conditions:
305305

306306
1. are from the ``regro-cf-autotick-bot``, have ``[bot-automerge]`` in the title, all statuses are passing, and the feedstock allows automerge
@@ -312,9 +312,9 @@ edits to the PR.
312312
Rerendering
313313
...........
314314

315-
The rerendering service is triggered by the Heroku app. It uses the GitHub action in this `repo <https://github.com/conda-forge/webservices-dispatch-action>`_.
316-
This action runs out of a Docker `container <https://hub.docker.com/repository/docker/condaforge/webservices-dispatch-action>`_ on the ``prod`` tag. See the
317-
repo `README.md <https://github.com/conda-forge/webservices-dispatch-action#readme>`_ for more details.
315+
The rerendering service is triggered by the Heroku app. It uses the GitHub action in this `repo <https://github.com/conda-forge/webservices-dispatch-action>`__.
316+
This action runs out of a Docker `container <https://hub.docker.com/repository/docker/condaforge/webservices-dispatch-action>`__ on the ``prod`` tag. See the
317+
repo `README.md <https://github.com/conda-forge/webservices-dispatch-action#readme>`__ for more details.
318318

319319

320320
Skipping CI builds

0 commit comments

Comments
 (0)