openstack/oslo.reports
Code Issues Proposed changes

rearrange content to fit the new standard layout

Browse Source 
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454

Change-Id: Ic8d93ffc98b347e4158c715b88d15372b0948887
This commit is contained in:
ChangBo Guo(gcb) 2017-06-26 16:04:09 +08:00
parent 05f4484cbc
commit 5ce4e61f18
12 changed files with 44 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -47,7 +47,7 @@ doc/build
# pbr generates these # pbr generates these
AUTHORS AUTHORS
ChangeLog ChangeLog
/doc/source/api/ doc/source/reference/api
# Editors # Editors
*~ *~

2
doc/source/contributing.rst → doc/source/contributor/index.rst
View File

@ -2,4 +2,4 @@
Contributing Contributing
============== ==============
.. include:: ../../CONTRIBUTING.rst .. include:: ../../../CONTRIBUTING.rst

1
doc/source/history.rst
View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

24
doc/source/index.rst
View File

@ -10,26 +10,10 @@ Contents
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
installation install/index
usage contributor/index
opts user/index
contributing reference/index
API
===
.. toctree::
:maxdepth: 2
api/autoindex
Release Notes
=============
.. toctree::
:maxdepth: 1
history
Indices and tables Indices and tables
================== ==================

6
doc/source/installation.rst → doc/source/install/index.rst
View File

@ -1,6 +1,6 @@
============== ============
Installation Installation
============== ============
At the command line:: At the command line::

18
doc/source/reference/index.rst Normal file
View File

@ -0,0 +1,18 @@
.. _using:
=========
Reference
=========
.. toctree::
:maxdepth: 2
opts
API
===
.. toctree::
:maxdepth: 1
api/autoindex

8
doc/source/opts.rst → doc/source/reference/opts.rst
View File

@ -1,6 +1,8 @@
======================= .. _option-definitions:
Configuration Options
======================= =====================
Configuration Options
=====================
oslo.reports uses oslo.config to define and manage configuration options oslo.reports uses oslo.config to define and manage configuration options
to allow the deployer to control where the GMR reports should be generated. to allow the deployer to control where the GMR reports should be generated.

1
doc/source/user/history.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../../ChangeLog

9
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,9 @@
===================
Using oslo.reports
===================
.. toctree::
:maxdepth: 2
usage
history

0
doc/source/report.txt → doc/source/user/report.txt
View File

0
doc/source/usage.rst → doc/source/user/usage.rst
View File

1
setup.cfg
View File

@ -24,6 +24,7 @@ packages =
[pbr] [pbr]
autodoc_index_modules = true autodoc_index_modules = true
api_doc_dir = reference/api
autodoc_exclude_modules = autodoc_exclude_modules =
oslo_reports._i18n oslo_reports._i18n
oslo_reports._utils oslo_reports._utils