# HG changeset patch # User Goffi # Date 1558942035 -7200 # Node ID b9a5418e9f2e8b40e3761c472611676848b1eb27 # Parent 170802865156c4cd050806d0ce69d430d3b47753 doc: added forgotten conf.py and index.rst files diff -r 170802865156 -r b9a5418e9f2e doc/conf.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/conf.py Mon May 27 09:27:15 2019 +0200 @@ -0,0 +1,177 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = u'Libervia (Salut à Toi)' +copyright = u'2019, Jérôme Poisson' +author = u'Jérôme Poisson' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'0.7' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# 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, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'LiberviaSalutToidoc' + + +# -- 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': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'LiberviaSalutToi.tex', u'Libervia (Salut à Toi) Documentation', + u'Jérôme Poisson', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'liberviasaluttoi', u'Libervia (Salut à Toi) Documentation', + [author], 1) +] + + +# -- 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 = [ + (master_doc, 'LiberviaSalutToi', u'Libervia (Salut à Toi) Documentation', + author, 'LiberviaSalutToi', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- diff -r 170802865156 -r b9a5418e9f2e doc/index.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/index.rst Mon May 27 09:27:15 2019 +0200 @@ -0,0 +1,35 @@ +.. Libervia (Salut à Toi) documentation master file, created by + sphinx-quickstart on Thu Jan 24 15:20:15 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Libervia (Salut à Toi) documentation +==================================== + +Welcome to Libervia's documentation. You'll find here both end-user end developer documentations. + +Libervia is the web frontend of Salut à Toi (or SàT), a Libre communication ecosystem based on XMPP standard. + +With Libervia you have access to main SàT features thanks to its easy to use pages. +It is a highly customizable project, the interface can be modified from slight to major changes, so it can be adapted to your association, university, entreprise or community. + +Libervia includes its own web framework, using a unique architecture taking profit of the XMPP standard. + +You can follow this documentation to learn more on it, or join our official XMPP room at `sat@chat.jabberfr.org `_ (also available via a `web link `_) + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + web_framework/quick_start.rst + web_framework/css_framework.rst + + + +Indices and tables +================== + +* :ref:`genindex` +.. + * :ref:`modindex` +* :ref:`search`