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
This commit is contained in:
Akihiro Motoki 2017-06-29 16:09:13 +09:00
parent d1efd47a0b
commit 43c6e3157c
3 changed files with 4 additions and 81 deletions

View File

@ -37,6 +37,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'openstackdocstheme']
repository_name = 'openstack/django_openstack_auth'
bug_project = 'django-openstack-auth'
bug_tag = ''
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -167,78 +168,3 @@ html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = 'DjangoOpenStackAuthdoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'DjangoOpenStackAuth.tex', u'Django OpenStack Auth Documentation',
u'Gabriel Hurley', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'djangoopenstackauth', u'Django OpenStack Auth Documentation',
[u'Gabriel Hurley'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'DjangoOpenStackAuth', u'Django OpenStack Auth Documentation',
u'Gabriel Hurley', 'DjangoOpenStackAuth', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

View File

@ -14,9 +14,6 @@ The current version is designed to work with the Keystone V2 or V3 API.
install/index
reference/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -1,6 +1,6 @@
==================
The ``User`` Class
==================
==============
The User Class
==============
.. automodule:: openstack_auth.user
:members: