Sphinx vs mkdocs?
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Ruhig
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Beginne mit dem Lesen der verlinkten aind-software-docs-Standards-Seite, untersuche anschließend die aktuelle Sphinx-Dokumentationskonfiguration dieses Templates und wie deren Standard ausgewählt wird. Vergleiche diese Konfiguration mit der genannten MkDocs-Empfehlung und halte fest, welchem Standard das Template folgen sollte; das Issue ist abgeschlossen, wenn die Entscheidung und die daraus resultierende Ausrichtung des Templates klar dokumentiert sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
aind-software-docs recommends using mkdocs, should the template conform to that instead of defaulting to sphinx docs?
- Vorherrschende Sprache
- Jinja
- Sterne
- 0
- Forks
- 0
- Ø Merge
- 13 Min.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus AllenNeuralDynamics/python-templates
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
hide unused badges by defaultEvtl. wieder frei @yosefmaru hat das vor 29 Tagen übernommen, und es ist kein Pull Request offen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 48/100
AllenNeuralDynamics/python-templates#10 · 1 zugewiesene Person ·
-
Add template version to templateEvtl. wieder frei @yosefmaru hat das vor 29 Tagen übernommen, und es ist kein Pull Request offen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 38/100
AllenNeuralDynamics/python-templates#6 · 1 Kommentar · 1 zugewiesene Person ·
Alle Issues in AllenNeuralDynamics/python-templates
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
ioos/compliance-checker#1375 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Nemotron section 4 never says which reasoning_effort values the family takes, and only `high` returns a traceEvtl. vergeben @sample-per-model-bedrock-dev-agent hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
aws-samples/sample-per-model-bedrock#207 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
restatedev/docs-restate#422 ·
Maintainer antworten meist innerhalb von 2 Tagen