reorder documentation
- reorder documentation so it's grouped logically. - add api docstring modules Change-Id: I47e49634fe7d8bb16a51f3045e7fe53683d56d1a
This commit is contained in:
parent
ba58d01057
commit
3e4f593984
2
.gitignore
vendored
2
.gitignore
vendored
@ -9,7 +9,7 @@ ChangeLog
|
|||||||
*.egg-info/
|
*.egg-info/
|
||||||
build/
|
build/
|
||||||
doc/build/
|
doc/build/
|
||||||
doc/source/api/autoindex.rst
|
doc/source/api
|
||||||
dist/
|
dist/
|
||||||
.testrepository/
|
.testrepository/
|
||||||
.project
|
.project
|
||||||
|
0
doc/ext/__init__.py
Normal file
0
doc/ext/__init__.py
Normal file
41
doc/ext/apidoc.py
Normal file
41
doc/ext/apidoc.py
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# Copyright 2013 OpenStack Foundation
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
# not use this file except in compliance with the License. You may obtain
|
||||||
|
# a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
# License for the specific language governing permissions and limitations
|
||||||
|
# under the License.
|
||||||
|
import os.path as path
|
||||||
|
|
||||||
|
from sphinx import apidoc
|
||||||
|
|
||||||
|
|
||||||
|
# NOTE(gordc): pbr will run Sphinx multiple times when it generates
|
||||||
|
# documentation. Once for each builder. To run this extension we use the
|
||||||
|
# 'builder-inited' hook that fires at the beginning of a Sphinx build.
|
||||||
|
# We use ``run_already`` to make sure apidocs are only generated once
|
||||||
|
# even if Sphinx is run multiple times.
|
||||||
|
run_already = False
|
||||||
|
|
||||||
|
|
||||||
|
def run_apidoc(app):
|
||||||
|
global run_already
|
||||||
|
if run_already:
|
||||||
|
return
|
||||||
|
run_already = True
|
||||||
|
|
||||||
|
package_dir = path.abspath(path.join(app.srcdir, '..', '..', 'pycadf'))
|
||||||
|
source_dir = path.join(app.srcdir, 'api')
|
||||||
|
apidoc.main(['apidoc', package_dir, '-f',
|
||||||
|
'-H', 'pyCADF Modules',
|
||||||
|
'-o', source_dir])
|
||||||
|
|
||||||
|
|
||||||
|
def setup(app):
|
||||||
|
app.connect('builder-inited', run_apidoc)
|
@ -1,8 +0,0 @@
|
|||||||
==============
|
|
||||||
API Reference
|
|
||||||
==============
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
autoindex
|
|
@ -13,6 +13,9 @@
|
|||||||
|
|
||||||
import sys, os
|
import sys, os
|
||||||
|
|
||||||
|
# NOTE(gordc): path for Sphinx ext.apidoc
|
||||||
|
sys.path.insert(0, os.path.abspath('..'))
|
||||||
|
|
||||||
# This is required for ReadTheDocs.org, but isn't a bad idea anyway.
|
# This is required for ReadTheDocs.org, but isn't a bad idea anyway.
|
||||||
os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
|
os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
|
||||||
|
|
||||||
@ -35,7 +38,8 @@ extensions = [
|
|||||||
'sphinx.ext.coverage',
|
'sphinx.ext.coverage',
|
||||||
'sphinx.ext.pngmath',
|
'sphinx.ext.pngmath',
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
'oslosphinx'
|
'oslosphinx',
|
||||||
|
'ext.apidoc'
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
@ -136,7 +140,7 @@ html_theme_options = {
|
|||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
html_static_path = ['_static']
|
#html_static_path = ['_static']
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
|
31
doc/source/contributing.rst
Normal file
31
doc/source/contributing.rst
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
..
|
||||||
|
Copyright 2014 IBM Corp.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
.. _contributing:
|
||||||
|
|
||||||
|
=============
|
||||||
|
Contributing
|
||||||
|
=============
|
||||||
|
|
||||||
|
Contributions to the pyCADF library is welcomed.
|
||||||
|
|
||||||
|
Important links:
|
||||||
|
|
||||||
|
1. `Github repository`_
|
||||||
|
|
||||||
|
2. `Launchpad project`_
|
||||||
|
|
||||||
|
.. _Github repository: https://github.com/openstack/pycadf
|
||||||
|
.. _Launchpad project: https://launchpad.net/pycadf
|
@ -35,18 +35,30 @@ contribute to the project.
|
|||||||
|
|
||||||
.. _CADF (Cloud Audit Data Federation Working Group): http://www.dmtf.org/standards/cadf
|
.. _CADF (Cloud Audit Data Federation Working Group): http://www.dmtf.org/standards/cadf
|
||||||
|
|
||||||
Table of contents
|
Getting Started
|
||||||
=================
|
===============
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
api/index
|
|
||||||
specification/index
|
|
||||||
event_concept
|
event_concept
|
||||||
middleware
|
middleware
|
||||||
|
|
||||||
.. update index
|
Developer Documentation
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
contributing
|
||||||
|
specification/index
|
||||||
|
|
||||||
|
Code Documentation
|
||||||
|
==================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
api/modules
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
@ -54,8 +66,3 @@ Indices and tables
|
|||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
|
||||||
To Do
|
|
||||||
=====
|
|
||||||
|
|
||||||
.. todolist::
|
|
||||||
|
Loading…
Reference in New Issue
Block a user