diff options
| author |   Sylvain Desbureaux <sylvain.desbureaux@orange.com> | 2020-12-09 10:13:42 +0100 |
|---|---|---|
| committer | Sylvain Desbureaux <sylvain.desbureaux@orange.com> | 2021-01-20 09:51:24 +0100 |
| commit | 090941b572c917d8e84ea709eb3696fdc8f53be1 (patch) | |
| tree | c88f912d2f4fa33a27b6bfad8b9042d23df0d96a /docs/conf.py | |
| parent | a9cdb59bd9907399984b9a4ee6bef792bfa9356f (diff) | |
[COMMON] Add doc linting
Add 3 automated doc linting (sphinx building, linkchecking and doc8) in
order to have an error free documentations
Fix also issues found by these linters in order to start without errors.
Issue-ID: OOM-2648
Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
Change-Id: I318718c956020412a120ba3caeb9e21d35a99833
(cherry picked from commit ec07bca720e5e2156be085e89f1ce8521a602eaf)
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py index 3b28eb74a8..a45acf370f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,6 +9,30 @@ linkcheck_ignore = [ intersphinx_mapping = {} +needs_services = { + 'github-issues': { + 'url': 'https://api.github.com/', + 'need_type': 'spec', + 'max_amount': 2, + 'max_content_lines': 20, + 'id_prefix': 'GH_ISSUE_' + }, + 'github-prs': { + 'url': 'https://api.github.com/', + 'need_type': 'spec', + 'max_amount': 2, + 'max_content_lines': 20, + 'id_prefix': 'GH_PR_' + }, + 'github-commits': { + 'url': 'https://api.github.com/', + 'need_type': 'spec', + 'max_amount': 2, + 'max_content_lines': 20, + 'id_prefix': 'GH_COMMIT_' + } +} + html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): |