Commit 780e0af2 authored by Adrian DC's avatar Adrian DC
Browse files

docs(tools): create 'git-dct' Python tools documentation page

Issue: #3
---

Signed-off-by: default avatarAdrian DC <radian.dc@gmail.com>
parent 380dc5fe
Loading
Loading
Loading
Loading
Loading
+1
Changes for .gitignore: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -23,6 +23,7 @@ dist/
/docs/alias.generated.md
/docs/assets/stylesheets/variables.scss
/docs/index.md
/docs/tools.generated.md
/public

# SonarQube intermediates
+1
Changes for docs/.pages.in: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -4,6 +4,7 @@ nav:
      - ‣ Usage: index.md
  - Tools:
      - ‣ Aliases: alias.md
      - ‣ Tools: tools.md
  - About:
      - ‣ Changelog: about/changelog/
      - ‣ License: about/license/
+27
Changes for docs/prepare.sh: 27 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -58,6 +58,33 @@ sed -i "s/%MKDOCS_EXPORTER_PDF_OUTPUT%/${MKDOCS_EXPORTER_PDF_OUTPUT:?}/g" "${doc
cp -f "${root_path}/README.md" "${docs_path}/index.md"
sed -i "s#\(\[.*\]\)(.*/docs/#\1(#g" "${docs_path}/index.md"

# Export tools
{
  tool_first='true'
  echo '<!-- generated documentation section -->'
  for tool_source in ./src/tools/git_*.py; do
    tool_script="${tool_source##*/}"
    tool_module="${tool_script%.py}"
    tool_alias="${tool_module#git_}"
    tool_description=$(sed -n '1{ s/^# //g; p }' './profiles/gitconfig/alias/'*"/${tool_alias}.alias")
    echo ''
    if [ "${tool_first}" = 'true' ]; then
      tool_first='false'
    else
      echo '---'
      echo ''
    fi
    echo "### git [${tool_alias}](../alias.gitconfig/) - ${tool_description}"
    echo ''
    echo '```yaml'
    python3 -m "src.tools.${tool_module}" --help \
      | tail -n+2 \
      | head -n-2
    echo '```'
  done
  echo ''
} >"${docs_path}/tools.generated.md"

# Bind 'md_in_html' extension
sed -i \
  -e 's/<\(details\)>/<\1 markdown>/g' \
+28
Changes for docs/tools.md: 28 added lines, 0 removed lines.
Original line number Diff line number Diff line
# git-dct

[![Release](https://img.shields.io/pypi/v/git-dct?color=blue)](https://pypi.org/project/git-dct)
[![Python](https://img.shields.io/pypi/pyversions/git-dct?color=blue)](https://pypi.org/project/git-dct)
[![Downloads](https://img.shields.io/pypi/dm/git-dct?color=blue)](https://pypi.org/project/git-dct)
[![License](https://img.shields.io/gitlab/license/RadianDevCore/tools/git-dct?color=blue)](https://gitlab.com/RadianDevCore/tools/git-dct/-/blob/main/LICENSE)
<br />
[![Build](https://gitlab.com/RadianDevCore/tools/git-dct/badges/main/pipeline.svg)](https://gitlab.com/RadianDevCore/tools/git-dct/-/commits/main/)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-dct&metric=bugs)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-dct)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-dct&metric=code_smells)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-dct)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-dct&metric=coverage)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-dct)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-dct&metric=ncloc)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-dct)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RadianDevCore_git-dct&metric=alert_status)](https://sonarcloud.io/dashboard?id=RadianDevCore_git-dct)
<br />
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)
[![gcil](https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/gcil)
[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)

Git development CLI tools for daily usage

---

[TOC]

<span class="page-break"></span>

{% include 'docs/tools.generated.md' %}