Context Navigation

guide.rst @ 11761

Last change on this file since 11761 was 11761, checked in by nicolasmartin, 5 years ago
Create unpub folder for unpublished READMEs (displayed with `make drafthtml`)
File size: 1.1 KB

Rev	Line
[10201]	1	#################
[10186]	2	Quick Start Guide
[10201]	3	#################
[10186]	4
[11761]	5	.. For headings markup, this convention is recommended from Python’s Style Guide
	6	# with overline, for parts
	7	* with overline, for chapters
	8	=, for sections
	9	-, for subsections
	10	^, for subsubsections
	11	", for paragraphs
[10186]	12
[11761]	13	'global.rst' contains a list of roles, substitutions and URL links for the guide.
	14	It is loaded for each file with the 'rst_epilog' setting in 'conf.py'
[10279]	15
[11761]	16	.. toctree::
	17	:hidden:
[11752]	18
[11761]	19	todos
[11752]	20
[11761]	21	.. Only displayed with 'make drafthtml'
[11752]	22
[10279]	23	.. toctree::
[10600]	24	:hidden:
[11761]	25	:caption: Unpublished READMEs
	26	:glob:
	27	:titlesonly:
	28
	29	unpub/*
	30
	31	.. Only displayed with 'make drafthtml'
	32
	33	.. toctree::
	34	:hidden:
[10600]	35	:caption: Getting started
[10279]	36
[10600]	37	install
[11718]	38	cfgs
	39	tests
[10279]	40
	41	.. toctree::
[10600]	42	:hidden:
	43	:caption: Setup your configuration
[10279]	44
[10600]	45	setup
[11734]	46	diags
[10600]	47	tools
[10279]	48
	49	.. toctree::
[10600]	50	:hidden:
	51	:caption: Advanced use
[10279]	52
[10600]	53	zooms
[11718]	54	cplg
	55	da
[10600]	56	tracers
[10279]	57
	58	.. toctree::
[10600]	59	:hidden:
[10602]	60	:caption: Miscellaneous
[10590]	61
[11718]	62	cite
	63	contrib
	64	changes
	65	acro
[10590]	66
[11713]	67	:Release: \|release\|
[10279]	68
[11713]	69	.. only:: draft
[10279]	70
[11761]	71	.. Only on draft
	72
[11718]	73	:Date: \|today\|
	74	:SVN rev: \|revision\|
	75
[11713]	76	.. include:: readme.rst

Note: See TracBrowser for help on using the repository browser.