sphinx-doc/sphinx

Improve support for pages without sections (titles)

Open

#8,356 opened on 2020年11月1日

GitHub で見る
 (4 comments) (2 reactions) (0 assignees)Python (1,985 forks)batch import
help wantedinternals:toctreetype:enhancement

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (平均マージ 10d 11h) (30d で 11 merged PRs)

説明

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.

コントリビューターガイド