Docs: Replace pdoc3 with Zensical, provide a project + API documentation
I maintainer di solito rispondono entro 3 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Tranquilla
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando la configurazione esistente della documentazione pdoc3 del repository e la documentazione sulla compatibilità di Zensical collegata. Definisci come devono essere fornite la documentazione del progetto e la documentazione automatica dell’API, quindi verifica che la migrazione completata produca entrambi i tipi di documentazione con la navigazione e il design previsti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 1.2k
- Fork
- 237
- Merge medio
- 4g 2h
- PR unite (30g)
- 9
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di OWASP/pytm
-
Dataflow defaults overwrite values the model set explicitlyForse già presa @markthomaschurch l’ha presa 1 giorno fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 30/100
I maintainer di solito rispondono entro 3 giorni
-
Calling TM.dfd() a second time returns an empty diagramForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 25/100
I maintainer di solito rispondono entro 3 giorni
-
Datastore icon is missing from SVG diagrams (absolute PNG path)Forse già presa @markthomaschurch l’ha presa 3 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 20/100
I maintainer di solito rispondono entro 3 giorni
-
Long boundary names render a literal "\n" in the DFDForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
I maintainer di solito rispondono entro 3 giorni
-
`TM.check()` overwrites explicit Dataflow `protocol`, `dstPort` and `controls.isEncrypted` with sink defaults (regression in 1.4.0)Forse già presa @Svastikkka l’ha presa 14 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 75/100
I maintainer di solito rispondono entro 3 giorni
Issue simili
-
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
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Huerte/algo-solutions-python#254 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 86/100
MichaelYcJo/SpecSeal#1543 ·
-
size/s
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
sipyourdrink-ltd/bernstein#7179 ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue help wanted python up-for-grabs
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
andrewsiah/agentswarm-data-tasks#309 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno