plotly / plotly/dash

allow users to create own docs apps

Abierto
#696 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

feature infrastructure P3
Lenguaje dominante
Python
Estrellas
24.4k
Forks
2.3k
Merge medio
2 d 7 h
PR fusionados (30 d)
13

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la configuración de Dash en varios archivos descrita en server.py y reproduce el fallo al cargar los callbacks usando pdoc3, incluido el issue de pdoc3 enlazado como contexto. Se considerará completado cuando exista una forma claramente compatible para que los usuarios generen documentación de referencia para sus propias aplicaciones de Dash sin provocar un registro duplicado de callbacks.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.