sphinx-doc/sphinx

Improve support for pages without sections (titles)

Open

#8.356 aberto em 1 de nov. de 2020

Ver no GitHub
 (4 comments) (2 reactions) (0 assignees)Python (1.985 forks)batch import
help wantedinternals:toctreetype:enhancement

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 30d)

Description

Is your feature request related to a problem? Please describe. Pages that don't have any section seems to be hard to work with. Also, their HTML <title> looks odd (in the browser tabs for example). Currently, a page that doesn't have any section (with for example html_title set to 'test') will render <no title> — test.

Also it seems like the document can't be included in any toctree, even explicitly (using Title <test_doc>).

Describe the solution you'd like

  • Ability to remove the <no title> — part so my page title is equal to html_title (for example in conf.py).
  • Allow to explicitly reference documents that have no sections in a toctree.

Describe alternatives you've considered I've tried patching it manually, without great success.

Guia do colaborador

Direção de pesquisa
Investigue como o Sphinx lida com páginas sem seções e como modificar a renderização do título e a inclusão no toctree. Analise o tema e as opções de configuração para permitir a personalização da exibição do título.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60