plotly / plotly/dash

allow users to create own docs apps

Ouverte
#696 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

feature infrastructure P3
Langage dominant
Python
Étoiles
24.4k
Forks
2.3k
Merge moyen
2 j 7 h
PR mergées (30 j)
13

Description

I am trying to create a documentation (more like reference for internal usage) for a Dash project (spanning many files, server.py holding the app and every other file loading the app from there). Is there a suggested way to do this?


I tried using pdoc3 but when trying to use it on any file containing a callback it seems be loading the same module multiple times thus triggering an error in Dash ("output with ID X alread exists"). I've opened an issue there (pdoc3 issue) hoping that I can at least get some pointers as to how to work around it, but I figured maybe someone here had a better suggestion to make.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la configuration Dash multi-fichier décrite dans server.py et reproduisez l’échec du chargement des callbacks avec pdoc3, en incluant l’issue pdoc3 liée pour fournir le contexte. Le travail sera considéré comme terminé lorsqu’il existera un moyen clairement pris en charge permettant aux utilisateurs de générer la documentation de référence de leurs propres applications Dash sans déclencher un enregistrement en double des callbacks.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.