No project description provided
Project description
Documentation du Package d'Extensions MkDocs DSFR
Ce document fournit une vue d'ensemble complète du package d'extensions MkDocs, y compris les détails sur chaque extension, la structure du projet, l'utilisation de Poetry, et les instructions pour l'installation et le développement.
Structure du Projet
dsfr_structure/
: Dossier racine du package.extension/
: Contient les différentes extensions.blockquote/
: Extension pour les blockquotes.__init__.py
: Contient la logique de l'extension de blockquote.
table/
: Extension pour les tables.__init__.py
: Contient la logique de l'extension de table.
all_extensions.py
: Fichier pour enregistrer toutes les extensions.
tests/
: Contient les tests unitaires pour les extensions.pyproject.toml
: Fichier de configuration Poetry pour le package.
Extensions
DsfrBlockQuoteExtension
- Fonctionnalité : Permet la transformation des citations en blocks de mise en exergue du DSFR
DsfrTableExtension
- Fonctionnalité : Permet la transformation des tableaux en tableaux du DSFR
Utilisation de Poetry
- Commandes Principales :
poetry install
: Pour installer les dépendances.poetry build
: Pour construire le package.poetry publish
: Pour publier le package sur PyPI.
Installation pour le Développement
- Clonez le dépôt : Accès au dépôt.
- Installation Locale : Utilisez
pip install -e .
pour installer le package en mode éditable pour le rendre disponible localement.
Tests
- Exécution des Tests : Comment exécuter les tests unitaires avec
poetry run test
oupython -m unittest discover -s tests
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dsfr_structure-0.1.0.tar.gz
(2.6 kB
view hashes)
Built Distribution
Close
Hashes for dsfr_structure-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2cb3b34b415b79e05f7ba41b5b0dda5067b850681274a0d689ef8dbd0c9ebf9 |
|
MD5 | eec96c777fecd24167f3582475deeb88 |
|
BLAKE2b-256 | 89de971ba4a9a1c0ec4a60052a9a8e3eda7bcf44a1ade4cb5216cbb7af071b7a |