From e6166fdb25d5344d77866f09b57faae453e1ae81 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Mon, 18 Oct 2021 17:15:21 +0200 Subject: [PATCH 1/3] Add readthedocs dashboard/import to markdown-link-check ignores --- .mlc-config.json | 3 +++ {{cookiecutter.directory_name}}/.mlc-config.json | 3 +++ 2 files changed, 6 insertions(+) diff --git a/.mlc-config.json b/.mlc-config.json index 7b0dfb57..9c07c43a 100644 --- a/.mlc-config.json +++ b/.mlc-config.json @@ -15,6 +15,9 @@ }, { "pattern": "^.github/workflows/sonarcloud.yml$" + }, + { + "pattern": "^https://readthedocs.org/dashboard/import.*" } ], "replacementPatterns": [ diff --git a/{{cookiecutter.directory_name}}/.mlc-config.json b/{{cookiecutter.directory_name}}/.mlc-config.json index 414b693f..bf8a4834 100644 --- a/{{cookiecutter.directory_name}}/.mlc-config.json +++ b/{{cookiecutter.directory_name}}/.mlc-config.json @@ -18,6 +18,9 @@ }, { "pattern": "^https://bestpractices.coreinfrastructure.org/projects/" + }, + { + "pattern": "^https://readthedocs.org/dashboard/import.*" } ], "replacementPatterns": [ From 5c72ce6766d372dcea7fc559c1968cb09559bbb1 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Mon, 18 Oct 2021 17:15:43 +0200 Subject: [PATCH 2/3] Update link to restructured text and sphinx cheatsheet --- {{cookiecutter.directory_name}}/project_setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.directory_name}}/project_setup.md b/{{cookiecutter.directory_name}}/project_setup.md index 858cac23..c99b85ba 100644 --- a/{{cookiecutter.directory_name}}/project_setup.md +++ b/{{cookiecutter.directory_name}}/project_setup.md @@ -53,7 +53,7 @@ help you decide which tool to use for packaging. - Documentation should be put in the [`docs/`](docs/) directory. The contents have been generated using `sphinx-quickstart` (Sphinx version 1.6.5). - We recommend writing the documentation using Restructured Text (reST) and Google style docstrings. - - [Restructured Text (reST) and Sphinx CheatSheet](http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html) + - [Restructured Text (reST) and Sphinx CheatSheet](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html) - [Google style docstring examples](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). - The documentation is set up with the ReadTheDocs Sphinx theme. - Check out its [configuration options](https://sphinx-rtd-theme.readthedocs.io/en/latest/). From 847aa628c1a412de3dba147740e85d70f04acab1 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Mon, 18 Oct 2021 17:31:27 +0200 Subject: [PATCH 3/3] Add retryOn429: true to markdown-link-check --- .mlc-config.json | 1 + {{cookiecutter.directory_name}}/.mlc-config.json | 1 + 2 files changed, 2 insertions(+) diff --git a/.mlc-config.json b/.mlc-config.json index 9c07c43a..95443f7b 100644 --- a/.mlc-config.json +++ b/.mlc-config.json @@ -22,5 +22,6 @@ ], "replacementPatterns": [ ], + "retryOn429": true, "timeout": "20s" } diff --git a/{{cookiecutter.directory_name}}/.mlc-config.json b/{{cookiecutter.directory_name}}/.mlc-config.json index bf8a4834..1d388679 100644 --- a/{{cookiecutter.directory_name}}/.mlc-config.json +++ b/{{cookiecutter.directory_name}}/.mlc-config.json @@ -25,5 +25,6 @@ ], "replacementPatterns": [ ], + "retryOn429": true, "timeout": "20s" }