AnswerDotAI / AnswerDotAI/nbdev

Question:How to set the default `title_level` of `show_doc`?

Offen
#1,476 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
Jupyter Notebook
Sterne
5.3k
Forks
513
Ø Merge
2 T. 30 Min.
Gemergte PRs (30 T.)
8

Beschreibung

`show_doc` is automatically added to every symbol I `#| export`, but I don't know how to control the parameter passed to `show_doc`, can you help me?

Especially, the `title_level=3` is really annoying. My markdown level have a level more than 3, so when I define a new function or class, the exported nbdev_docs are very ugly!

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit nachzuverfolgen, wie #| export show_doc hinzufügt und wo der Parameter title_level derzeit gesetzt wird. Ermittle den vorgesehenen Konfigurationspunkt und dokumentiere oder implementiere eine Möglichkeit, den Standardwert zu steuern. Überprüfe anschließend, dass die generierten nbdev_docs die angeforderte Überschriftenebene verwenden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter, python
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

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