sphinx-doc/sphinx

Feature Request: Add sample page with formatting when quickstart project

Open

#4,731 opened on 2018年3月12日

GitHub で見る
 (2 comments) (2 reactions) (0 assignees)Python (1,985 forks)batch import
api:cmdlinehelp wantedtype:proposal

Repository metrics

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

説明

The open source project I help with are looking at Sphinx to replace our mediawiki install.

I have been trying to learn how to get it going and the biggest confusion I ran into was how to add pages and doing text formatting. There is a fair amount of documentation online, but much of it is written for older versions of Sphinx which make it confusing to know what is useful.

Feature: Have a sample page (not toc) that has a variety of reStructuredText formatting examples in it.

Not only can this help people learn how sphinx structures files in the toc, but this also makes it easier for theme developers. If I want to do theming, I can easily see a lot of the variation that might appear as an author is writing stuff down.

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