Simplify project doc templates
Remove the separate file that includes README.rst. Fix up the title string generation at the top of index.rst. Add default api.rst. Remove virtualenvwrapper instructions from usage.rst since we don't need those. Add history.rst file. Change-Id: Ieda600538c1868a64dd2fea7142e13ea3b846de5
This commit is contained in:
parent
7f5f759f19
commit
7861e1f25c
|
@ -0,0 +1,12 @@
|
|||
=====
|
||||
API
|
||||
=====
|
||||
|
||||
.. Use autodoc directives to describe the *public* modules and classes
|
||||
in the library.
|
||||
|
||||
If the modules are completely unrelated, create an api subdirectory
|
||||
and use a separate file for each (see oslo.utils).
|
||||
|
||||
If there is only one submodule, a single api.rst file like this
|
||||
sufficient (see oslo.i18n).
|
|
@ -0,0 +1 @@
|
|||
.. include:: ../../ChangeLog
|
|
@ -1,20 +1,20 @@
|
|||
.. oslo.{{ cookiecutter.module_name }} documentation master file, created by
|
||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
======{% for _ in cookiecutter.module_name %}={% endfor %}=
|
||||
oslo.{{ cookiecutter.module_name }}
|
||||
======{% for _ in cookiecutter.module_name %}={% endfor %}=
|
||||
|
||||
Welcome to oslo.{{ cookiecutter.module_name }}'s documentation!
|
||||
===============================================================
|
||||
{{ cookiecutter.project_short_description}}
|
||||
|
||||
Contents:
|
||||
Contents
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
api
|
||||
usage
|
||||
contributing
|
||||
history
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
|
|
@ -1,12 +1,7 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
==============
|
||||
Installation
|
||||
==============
|
||||
|
||||
At the command line::
|
||||
|
||||
$ pip install oslo.{{ cookiecutter.module_name }}
|
||||
|
||||
Or, if you have virtualenvwrapper installed::
|
||||
|
||||
$ mkvirtualenv oslo.{{ cookiecutter.module_name }}
|
||||
$ pip install oslo.{{ cookiecutter.module_name }}
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../README.rst
|
|
@ -1,6 +1,6 @@
|
|||
========
|
||||
Usage
|
||||
========
|
||||
=======
|
||||
Usage
|
||||
=======
|
||||
|
||||
To use oslo.{{ cookiecutter.module_name }} in a project::
|
||||
|
||||
|
|
Loading…
Reference in New Issue