openstack/specs-cookiecutter
Code Issues Proposed changes

Update index to make it more legible

Browse Source 
This commit changes the organization of the index to make it clear
what is documentation and what is a spec file.
This commit is contained in:
Matthew Treinish 2014-03-26 14:54:31 -04:00
parent 8738f58981
commit 111da2a1d8
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
{{cookiecutter.repo_name}}/doc/source/index.rst
View File

@ -3,19 +3,25 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to {{ cookiecutter.repo_name }}'s documentation!
========================================================
Contents:
{{ cookiecutter.repo_name }} Design Specifications
==================================================
.. toctree::
:glob:
:maxdepth: 2
readme
contributing
../../specs/*
{{ cookiecutter.repo_name }} Repository Information
===================================================
.. toctree::
:maxdepth: 2
readme <readme>
contributing <contributing>
Indices and tables
==================