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

Aberta
  • Algo errado?
#1,476 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
30/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
jupyter, python
Domínio
documentation

Direção de pesquisa

Comece rastreando como #| export adiciona show_doc e onde o parâmetro title_level é definido atualmente. Determine o ponto de configuração pretendido e documente ou implemente uma forma de controlar o valor padrão; em seguida, verifique se os nbdev_docs gerados usam o nível de título solicitado.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

bug

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!

Linguagem predominante
Jupyter Notebook
Estrelas
5.3k
Forks
514
Merge médio
2d 7h
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de AnswerDotAI/nbdev

Todas as issues de AnswerDotAI/nbdev

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.