plotly / plotly/dash

allow users to create own docs apps

Offen
#696 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature infrastructure P3
Vorherrschende Sprache
Python
Sterne
24.4k
Forks
2.3k
Ø Merge
2 T. 7 Std.
Gemergte PRs (30 T.)
13

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem in server.py beschriebenen Dash-Setup mit mehreren Dateien und reproduziere den Fehler beim Laden der Callbacks mit pdoc3, einschließlich des verlinkten pdoc3-Issues als Kontext. Als abgeschlossen gilt die Aufgabe, wenn es eine eindeutig unterstützte Möglichkeit gibt, mit der Benutzer Referenzdokumentation für ihre eigenen Dash-Apps generieren können, ohne eine doppelte Registrierung von Callbacks auszulösen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.