diff --git a/templates/docs/_data/template/repo.tpl.yaml b/templates/docs/_data/template/repo.tpl.yaml index e86ea591a9789ec0a7728e068c997aa9f079dc57..b4ce1913d8cfc508dcf71bb162a6ebfed3ed6e73 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 d23a85e17a4e7639e7b653ed7a806534431be4fb..a62c63239fba08640d5290dfafd91c27fd993493 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"