Cleaner left-hand table-of-contents for API reference
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 38/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Comece localizando a configuração do Sphinx/AutoAPI que gera a referência da API na documentação do Read the Docs. Verifique se as opções podem produzir o nome solicitado para o pacote de nível superior e rótulos mais curtos para os submódulos. Está concluído quando a navegação à esquerda renderizada exibir “hats API reference” com entradas como “catalog” e “inspection”, sem repetir os nomes dos pacotes.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Looking at the HATS RTD, the menu options in the left-hand-side for the API reference have a lot of unnecessary duplication:
API reference
└── hats
├── hats.catalog
├── hats.inspection
└── ...
I would really love if we could have it be simpler:
hats API reference
├── catalog
├── inspection
└── ...
this includes the package name in the top-level, and omits the package name from the submodule names.
I don't even know if sphinx/autoapi supports this, but I can dream, right?
- Linguagem predominante
- Jinja
- Estrelas
- 85
- Forks
- 16
- Merge médio
- 1d 5h
- PRs com merge (30d)
- 10
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Sem guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de lincc-frameworks/python-project-template
-
documentation good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
lincc-frameworks/python-project-template#589 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
lincc-frameworks/python-project-template#574 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
lincc-frameworks/python-project-template#605 ·
Mantenedores costumam responder em até 1 dia
-
enhancement
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
lincc-frameworks/python-project-template#588 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
lincc-frameworks/python-project-template#580 · 1 comentário · 1 reação ·
Mantenedores costumam responder em até 1 dia
Todas as issues de lincc-frameworks/python-project-template
Issues semelhantes
-
[scanner] check:spelling skips blog/ — posts and author metadata are never spell-checkedTalvez já em andamento @hivecommons-hive assumiu hoje. Abertaagent/scanner bug hive/covered-by-pr hive/hosted-available-lke648397-260827-5n31
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100
cncf/endusers#1452 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
documentation
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 62/100
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
hummingbot/condor#283 ·
Mantenedores costumam responder em até 1 dia
-
README for cliTalvez já em andamento @Janvi-kapoor assumiu hoje. AbertaOSCI'26
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
GauravKarakoti/SecureFlow#1308 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
vitest-dev/vitest#11577 ·
Mantenedores costumam responder em até 1 dia