summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkihiro Motoki <amotoki@gmail.com>2017-06-29 16:09:13 +0900
committerAkihiro Motoki <amotoki@gmail.com>2017-06-30 02:02:14 +0900
commit43c6e3157cccf3e8c30c1839da9a0ad8a52416d8 (patch)
tree45c2e115149184d544940b78f28315dcca7c3ab4
parentd1efd47a0b19072bc30a5d8206a0d5bfff3cdbb7 (diff)
doc: cleanup doc build configuration
* Populate doc build timestamp * Fix the title of reference/user.rst as openstackdocstheme does not handle a title string with backquoted string in the nav icons. * Remove unnecessary build configurations (manpage, latex, texinfo) * Remove the heading "Indices and tables" in index.rst. It simplifies the toc of the top page. Change-Id: If35bd99ee203105418ea49eb921b2d6d428e0187
Notes
Notes (review): Code-Review+2: Rob Cresswell <robert.cresswell@outlook.com> Workflow+1: Rob Cresswell <robert.cresswell@outlook.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 30 Jun 2017 12:25:21 +0000 Reviewed-on: https://review.openstack.org/478773 Project: openstack/django_openstack_auth Branch: refs/heads/master
-rw-r--r--doc/source/conf.py76
-rw-r--r--doc/source/index.rst3
-rw-r--r--doc/source/reference/user.rst6
3 files changed, 4 insertions, 81 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 025fcc7..9faa27e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -37,6 +37,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'openstackdocstheme']
37repository_name = 'openstack/django_openstack_auth' 37repository_name = 'openstack/django_openstack_auth'
38bug_project = 'django-openstack-auth' 38bug_project = 'django-openstack-auth'
39bug_tag = '' 39bug_tag = ''
40html_last_updated_fmt = '%Y-%m-%d %H:%M'
40 41
41# Add any paths that contain templates here, relative to this directory. 42# Add any paths that contain templates here, relative to this directory.
42templates_path = ['_templates'] 43templates_path = ['_templates']
@@ -167,78 +168,3 @@ html_theme = 'openstackdocs'
167 168
168# Output file base name for HTML help builder. 169# Output file base name for HTML help builder.
169htmlhelp_basename = 'DjangoOpenStackAuthdoc' 170htmlhelp_basename = 'DjangoOpenStackAuthdoc'
170
171
172# -- Options for LaTeX output --------------------------------------------------
173
174latex_elements = {
175 # The paper size ('letterpaper' or 'a4paper').
176 #'papersize': 'letterpaper',
177
178 # The font size ('10pt', '11pt' or '12pt').
179 #'pointsize': '10pt',
180
181 # Additional stuff for the LaTeX preamble.
182 #'preamble': '',
183}
184
185# Grouping the document tree into LaTeX files. List of tuples
186# (source start file, target name, title, author, documentclass [howto/manual]).
187latex_documents = [
188 ('index', 'DjangoOpenStackAuth.tex', u'Django OpenStack Auth Documentation',
189 u'Gabriel Hurley', 'manual'),
190]
191
192# The name of an image file (relative to this directory) to place at the top of
193# the title page.
194#latex_logo = None
195
196# For "manual" documents, if this is true, then toplevel headings are parts,
197# not chapters.
198#latex_use_parts = False
199
200# If true, show page references after internal links.
201#latex_show_pagerefs = False
202
203# If true, show URL addresses after external links.
204#latex_show_urls = False
205
206# Documents to append as an appendix to all manuals.
207#latex_appendices = []
208
209# If false, no module index is generated.
210#latex_domain_indices = True
211
212
213# -- Options for manual page output --------------------------------------------
214
215# One entry per manual page. List of tuples
216# (source start file, name, description, authors, manual section).
217man_pages = [
218 ('index', 'djangoopenstackauth', u'Django OpenStack Auth Documentation',
219 [u'Gabriel Hurley'], 1)
220]
221
222# If true, show URL addresses after external links.
223#man_show_urls = False
224
225
226# -- Options for Texinfo output ------------------------------------------------
227
228# Grouping the document tree into Texinfo files. List of tuples
229# (source start file, target name, title, author,
230# dir menu entry, description, category)
231texinfo_documents = [
232 ('index', 'DjangoOpenStackAuth', u'Django OpenStack Auth Documentation',
233 u'Gabriel Hurley', 'DjangoOpenStackAuth', 'One line description of project.',
234 'Miscellaneous'),
235]
236
237# Documents to append as an appendix to all manuals.
238#texinfo_appendices = []
239
240# If false, no module index is generated.
241#texinfo_domain_indices = True
242
243# How to display URL addresses: 'footnote', 'no', or 'inline'.
244#texinfo_show_urls = 'footnote'
diff --git a/doc/source/index.rst b/doc/source/index.rst
index d7f72c4..9f93215 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -14,9 +14,6 @@ The current version is designed to work with the Keystone V2 or V3 API.
14 install/index 14 install/index
15 reference/index 15 reference/index
16 16
17Indices and tables
18==================
19
20* :ref:`genindex` 17* :ref:`genindex`
21* :ref:`modindex` 18* :ref:`modindex`
22* :ref:`search` 19* :ref:`search`
diff --git a/doc/source/reference/user.rst b/doc/source/reference/user.rst
index 910657e..f54587c 100644
--- a/doc/source/reference/user.rst
+++ b/doc/source/reference/user.rst
@@ -1,6 +1,6 @@
1================== 1==============
2The ``User`` Class 2The User Class
3================== 3==============
4 4
5.. automodule:: openstack_auth.user 5.. automodule:: openstack_auth.user
6 :members: 6 :members: