Docs: Replace pdoc3 with Zensical, provide a project + API documentation
Los mantenedores suelen responder en 3 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Tranquilo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza revisando la configuración de documentación pdoc3 existente del repositorio y la documentación de compatibilidad de Zensical enlazada. Define cómo deben proporcionarse la documentación del proyecto y la documentación automática de la API, y verifica después que la migración completada genere ambos tipos de documentación con la navegación y el diseño previstos.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
pdoc3 is pretty limited and not really a state of the art tool for automated API and project documentation anymore.
So far a kind of de-facto standard for modern Python project documentation including automatic API generation has been MKDocs + Material for MKDocs + mkdocstrings for quite some years.
Zensical is the new tool that deprecates MkDocs + Material for MKDocs which will go into maintenance mode as mkdocstrings will. Zensical is developed by the same team as Material for MKDocs and mkdocstrings is and improves design wise limitations of the MKDocs based documentation tech stack.
Zensical almost reached feature parity with Material for MKDocs, supports mkdocsstrings already (until there is added a Zensical-"native" mkdocstrings replacement?) and aims at being backwards compatible.
- Lenguaje dominante
- Python
- Estrellas
- 1.2k
- Forks
- 237
- Merge medio
- 4 d 2 h
- PR fusionados (30 d)
- 9
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de OWASP/pytm
-
Dataflow defaults overwrite values the model set explicitlyPosiblemente ocupada @markthomaschurch la tomó hace 1 día. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 30/100
Los mantenedores suelen responder en 3 días
-
Calling TM.dfd() a second time returns an empty diagramQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 25/100
Los mantenedores suelen responder en 3 días
-
Datastore icon is missing from SVG diagrams (absolute PNG path)Posiblemente ocupada @markthomaschurch la tomó hace 3 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 20/100
Los mantenedores suelen responder en 3 días
-
Long boundary names render a literal "\n" in the DFDQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
Los mantenedores suelen responder en 3 días
-
`TM.check()` overwrites explicit Dataflow `protocol`, `dstPort` and `controls.isEncrypted` with sink defaults (regression in 1.4.0)Posiblemente ocupada @Svastikkka la tomó hace 14 días. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 75/100
OWASP/pytm#373 · 1 comentario ·
Los mantenedores suelen responder en 3 días
Todos los issues de OWASP/pytm
Issues similares
-
15-minutes 5-minutes algorithm any-language beginner-friendly c cpp csharp easy go good first issue hacktoberfest help wanted java javascript kotlin python rust swift typescript
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Huerte/algo-solutions-python#254 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 86/100
MichaelYcJo/SpecSeal#1543 ·
-
size/s
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
sipyourdrink-ltd/bernstein#7179 ·
Los mantenedores suelen responder en 1 día
-
good first issue help wanted python up-for-grabs
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
andrewsiah/agentswarm-data-tasks#309 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 1 día