sphinx-doc/sphinx

Improve support for pages without sections (titles)

Open

#8 356 ouverte le 1 nov. 2020

Voir sur GitHub
 (4 commentaires) (2 réactions) (0 assignés)Python (1 985 forks)batch import
help wantedinternals:toctreetype:enhancement

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 10j 11h) (11 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examiner comment Sphinx gère les pages sans sections et comment modifier le rendu du titre et l'inclusion dans toctree. Explorez le thème et les options de configuration pour personnaliser l'affichage du titre.
Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60