lincc-frameworks / lincc-frameworks/python-project-template

Cleaner left-hand table-of-contents for API reference

Aberta
#499 4 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Jinja
Estrelas
85
Forks
16
Merge médio
6h 18min
PRs com merge (30d)
1

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?

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

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.

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.

Avaliação

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

Receba novas issues na sua caixa de entrada

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