tekrepodoc

tékrépodoc

Outil d'utilité pour générer des fichiers de projet communs à l'aide de modèles sensés sur lesquels tout le monde peut s'entendre. Utile pour les référentiels GIT, prend en charge les modèles Sphinx, les fichiers de santé communautaire, les lectures, les configurations du projet PYPI.

---

Table des matières

• Start
• Documentation / utilisation
• Contributif
• Crédits

---

Start

Installation

 pip install tekrepodoc 

De la source

 git clone https://github.com/TralahM/tekrepodoc
cd tekrepodoc

python setup.py bdist_wheel
pip install -e .

---

Utilisation de la CLI

Dans le type de terminal

 repodoc -h 

 usage: repodoc [-h] [-u] [-bc] [-zc] [-vv] [-v]
               {get_vars,config,licence,readme,community_health,comh,ch,pypi_project,pypi,sphinx_docs,docs,sphinx,dot_files,dots}
               ...

options:
  -h, --help            show this help message and exit
  -u, --use-config-file
                        use config file for template variables.
  -bc, --bash-completion
                        Print Bash Completion Script.
  -zc, --zsh-completion
                        Print ZSH Completion Script.
  -vv, --verbose        Turn on Verbose Mode.
  -v, --version         show program's version number and exit

subcommands:
  {get_vars,config,licence,readme,community_health,comh,ch,pypi_project,pypi,sphinx_docs,docs,sphinx,dot_files,dots}
    get_vars            Return all variables for the given template.
    config              Configure Subcommand to init,set,get,list configs.
    licence             Generate Licence Command.
    readme              Generate README command.
    community_health (comh, ch)
                        Generate Community Health Guidelines.
    pypi_project (pypi)
                        Generate Pypi Manifest,setup.cfg,setup.py Command.
    sphinx_docs (docs, sphinx)
                        Generate Sphinx Documentation Templates.
    dot_files (dots)    Generate all dot files
                        .gitignore,.gitattributes,.mailmap.

Author: Tralah M Brian (TralahM) <[email protected]>. Project:
<https://github.com/TralahM/tekrepodoc>

Générer d'abord un fichier de configuration

 repodoc config --init

Documentation

Référence de l'API

---

Contributif

---

Avis juridique

Si ce référentiel utilise des API et ou des modèles AI tiers, il n'est pas associé ou approuvé par les fournisseurs d'API ou les développeurs originaux des modèles.

Veuillez noter ce qui suit:

Avertissement : les API, les services et les marques mentionnées dans ce référentiel appartiennent à leurs propriétaires respectifs. Ce projet ne revendique aucun droit sur eux.

Responsabilité : L'auteur de ce référentiel n'est pas responsable des conséquences résultant de l'utilisation ou de l'utilisation abusive de ce référentiel ou du contenu fourni par les API tiers et de tout dommage ou perte causée par les actions des utilisateurs.

Objectifs éducatifs uniquement : ce référentiel et son contenu sont fournis strictement à des fins éducatives. En utilisant les informations et le code fournis, les utilisateurs reconnaissent qu'ils utilisent les API et les modèles à leurs propres risques et acceptent de se conformer à toutes les lois et réglementations applicables.

Crédits