From d51ce1a9417f8c3fb54a45b40ccd6e2a3db69d77 Mon Sep 17 00:00:00 2001 From: Romain Deville <code@romaindeville.fr> Date: Thu, 6 May 2021 23:00:36 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=F0=9F=92=A1=20Update=20source=20do?= =?UTF-8?q?cumentation=20in=20template=20files?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- templates/docs/_data/template/repo.tpl.yaml | 8 +++++--- templates/docs/_data/template/subrepo.tpl.yaml | 8 ++++++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/templates/docs/_data/template/repo.tpl.yaml b/templates/docs/_data/template/repo.tpl.yaml index e86ea59..b4ce191 100644 --- a/templates/docs/_data/template/repo.tpl.yaml +++ b/templates/docs/_data/template/repo.tpl.yaml @@ -26,11 +26,13 @@ repo_name: # (OPTIONAL) Path, relative to `docs_dir` mkdocs config, to the logo of the # repo. If not specified, path will automatically be set to - # `assets/img/meta/reop_name_logo.png` - #logo: "assets/img/meta/repo_template_logo.png" + # `assets/img/meta/repo_name_logo.png` + #logo: "assets/img/meta/repo_name_logo.png" # Description of the repo, will be used to setup the mkdocs description. desc: >- - Repo description with markdown support + An explicit description to explain what my repo do. Can be a multiline + description with **markdown** support such as + [link](https://url.domain.tld) and more. # (OPTIONAL) If you plan to use `mkdocstring` plugins to render python # source code, you will need to provide the path where your source files diff --git a/templates/docs/_data/template/subrepo.tpl.yaml b/templates/docs/_data/template/subrepo.tpl.yaml index d23a85e..a62c632 100644 --- a/templates/docs/_data/template/subrepo.tpl.yaml +++ b/templates/docs/_data/template/subrepo.tpl.yaml @@ -22,6 +22,10 @@ subrepo: # - name: subrepo_1 # # SSH or HTTP link to the online subrepo_1 # git_url: git@domain.tld:namesapce/subrepo_1 + # # Key `subpath` is a str pointing to the path in the subrepo where + # # there is a file `mkdocs.yaml` and folder `docs` if not the root + # # of the subrepo + # subpath: sub/dir/ # # List of subdirectory from `dir_name` which are repos with # # mkdocs documentation which will be included in the documentation. # external: @@ -31,6 +35,10 @@ subrepo: # - name: subrepo_2 # # SSH or HTTP link to the online subrepo_2 # git_url: git@domain.tld:namesapce/subrepo_2 + # # Key `subpath` is a str pointing to the path in the subrepo where + # # there is a file `mkdocs.yaml` and folder `docs` if not the root + # # of the subrepo + # subpath: sub/dir/ # # Another sub dir_name which also old subrepos # subdir_name: # nav_entry: "Sub Nav Entry" -- GitLab