openstack/api-sig
Code Issues Proposed changes

Clean up comments from initial code drop

Browse Source 
There were a few comments from the initial code drop from:
https://review.openstack.org/#/c/130120/1

Change-Id: I48e8be72f0d6245a57830ce14eed99df3c1ae65c
This commit is contained in:
Steve Martinelli 2014-10-22 16:15:01 -04:00
parent e00144c3a0
commit a46953e765
3 changed files with 14 additions and 23 deletions

31
doc/source/conf.py

@ -32,13 +32,8 @@ extensions = ['redirect',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'oslosphinx',
'yasfb',
]
# Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/nova-specs'
feed_author = 'OpenStack Nova Team'
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
@ -54,8 +49,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Nova Specs'
copyright = u'%s, OpenStack Nova Team' % datetime.date.today().year
project = u'API Working Group'
copyright = u'%s, OpenStack API Working Group Team' % datetime.date.today().year
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -71,8 +66,6 @@ copyright = u'%s, OpenStack Nova Team' % datetime.date.today().year
# directories to ignore when looking for source files.
exclude_patterns = [
'_build',
'specs/juno-template.rst',
'specs/kilo-template.rst',
]
# The reST default role (used for this markup: `text`) to use for all documents.
@ -93,7 +86,7 @@ show_authors = False
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['nova-specs.']
modindex_common_prefix = []
# -- Options for man page output ----------------------------------------------
man_pages = []
@ -171,7 +164,7 @@ html_use_index = False
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'Nova-Specsdoc'
htmlhelp_basename = 'API-WGdoc'
# -- Options for LaTeX output --------------------------------------------------
@ -190,8 +183,8 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Nova-specs.tex', u'Nova Specs',
u'OpenStack Nova Team', 'manual'),
('index', 'api-wg.tex', u'API Working Group',
u'OpenStack API Working Group Team', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@ -220,8 +213,8 @@ latex_documents = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Nova-specs', u'Nova Design Specs',
u'OpenStack Nova Team', 'nova-specs', 'Design specifications for the Nova project.',
('index', 'api-wg', u'API Working Group',
u'OpenStack API Working Group Team', 'nova-specs', 'Guidelines for OpenStack APIs.',
'Miscellaneous'),
]
@ -238,10 +231,10 @@ texinfo_documents = [
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'Nova Specs'
epub_author = u'OpenStack Nova Team'
epub_publisher = u'OpenStack Nova Team'
epub_copyright = u'2014, OpenStack Nova Team'
epub_title = u'API Working Group'
epub_author = u'OpenStack API Working Group Team'
epub_publisher = u'OpenStack API Working Group Team'
epub_copyright = u'2014, OpenStack API Working Group Team'
# The language of the text. It defaults to the language option
# or en if the language is not set.

5
doc/source/index.rst

@ -1,7 +1,7 @@
.. api-wg documentation master file
===========================
Openstack API Working Group
OpenStack API Working Group
===========================
This document contains the guidelines and rules for OpenStack project
@ -11,10 +11,9 @@ including guidelines and proposed rules concerning API consistency, naming
conventions, and best practice recommendations.
If you are interested in contributing to this document, the git repository is
available at http://git.openstack.org/cgit/openstack/api-wg/
available at: http://git.openstack.org/cgit/openstack/api-wg/
OpenStack code and review submission processes are described here:
https://wiki.openstack.org/wiki/How_To_Contribute

1
requirements.txt

@ -3,4 +3,3 @@ pbr>=0.6,<1.0
sphinx>=1.1.2,<1.2
testrepository>=0.0.18
testtools>=0.9.34
yasfb>=0.5.1