Browse Source

added group document to the generated documentation

master
Julio Biason 11 years ago
parent
commit
06779c38e3
  1. 8
      doc/client/groups.rst
  2. 1
      doc/client/index.rst
  3. 14
      doc/conf.py

8
doc/client/groups.rst

@ -0,0 +1,8 @@
Groups
=======
Groups are used to select which people will go to which place.
.. autoflask:: luncho.server:app
:blueprints: groups
:undoc-endpoints: static, show_api

1
doc/client/index.rst

@ -73,3 +73,4 @@ API
:maxdepth: 3 :maxdepth: 3
users_and_tokens users_and_tokens
groups

14
doc/conf.py

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
# Luncho-o documentation build configuration file, created by # Lunch-o documentation build configuration file, created by
# sphinx-quickstart on Tue Mar 25 20:35:08 2014. # sphinx-quickstart on Tue Mar 25 20:35:08 2014.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
@ -50,7 +50,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Luncho-o' project = u'Lunch-o'
copyright = u'2014, Julio Biason' copyright = u'2014, Julio Biason'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
@ -184,7 +184,7 @@ html_static_path = ['_static']
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'Luncho-odoc' htmlhelp_basename = 'Lunch-odoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
@ -204,7 +204,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', 'Luncho-o.tex', u'Luncho-o Documentation', ('index', 'Lunch-o.tex', u'Lunch-o Documentation',
u'Julio Biason', 'manual'), u'Julio Biason', 'manual'),
] ]
@ -234,7 +234,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'luncho-o', u'Luncho-o Documentation', ('index', 'luncho-o', u'Lunch-o Documentation',
[u'Julio Biason'], 1) [u'Julio Biason'], 1)
] ]
@ -248,8 +248,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'Luncho-o', u'Luncho-o Documentation', ('index', 'Lunch-o', u'Lunch-o Documentation',
u'Julio Biason', 'Luncho-o', 'Lunch for groups.', u'Julio Biason', 'Lunch-o', 'Lunch for groups.',
'Miscellaneous'), 'Miscellaneous'),
] ]

Loading…
Cancel
Save