diff --git a/ippisite/docs/Makefile b/ippisite/docs/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..69fe55ecfa9aade66e1412aef0ee7d04a9bcde86 --- /dev/null +++ b/ippisite/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/ippisite/docs/source/conf.py b/ippisite/docs/source/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..0e1e49ba0cb61726c3dd0aef640a9cdf42fdff84 --- /dev/null +++ b/ippisite/docs/source/conf.py @@ -0,0 +1,192 @@ +# -*- 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('.')) +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +import django +os.environ['DJANGO_SETTINGS_MODULE'] = 'ippisite.settings' +django.setup() + +# -- Project information ----------------------------------------------------- + +project = 'iPPI-DB' +copyright = '2018, Rachel Torchet, Alexandra Moine-Franel, Hélène Borges, Bryan Brancotte, Olivia Doppelt-Azeroual, Fabien Mareuil, Hervé Ménager, Olivier Sperandio' +author = 'Rachel Torchet, Alexandra Moine-Franel, Hélène Borges, Bryan Brancotte, Olivia Doppelt-Azeroual, Fabien Mareuil, Hervé Ménager, Olivier Sperandio' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- 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.autosummary', + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.viewcode', +] + +# 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 = [] + +# 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 = 'sphinx_rtd_theme' + + +# 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 = 'iPPI-DBdoc' + + +# -- 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, 'iPPI-DB.tex', 'iPPI-DB Documentation', + 'Rachel Torchet, Alexandra Moine-Franel, Hélène Borges, Bryan Brancotte, Olivia Doppelt-Azeroual, Fabien Mareuil, Hervé Ménager, Olivier Sperandio', '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, 'ippi-db', 'iPPI-DB 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, 'iPPI-DB', 'iPPI-DB Documentation', + author, 'iPPI-DB', '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 ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/ippisite/docs/source/index.rst b/ippisite/docs/source/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..243f944dbc445551d9c23f52d83371651c6f138f --- /dev/null +++ b/ippisite/docs/source/index.rst @@ -0,0 +1,21 @@ +.. iPPI-DB documentation master file, created by + sphinx-quickstart on Wed Nov 28 16:32:00 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to iPPI-DB's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + modules + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/ippisite/docs/source/modules.rst b/ippisite/docs/source/modules.rst new file mode 100644 index 0000000000000000000000000000000000000000..cba2f2f473b2aa1e16b3e541b088cc5252aee28e --- /dev/null +++ b/ippisite/docs/source/modules.rst @@ -0,0 +1,6 @@ +IPPIDB Python API reference +=========================== + +.. automodule:: ippidb + :members: + diff --git a/ippisite/ippidb/__init__.py b/ippisite/ippidb/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..c40bce04c90c8a8ce045c5d4d83fb2141c3f8086 100644 --- a/ippisite/ippidb/__init__.py +++ b/ippisite/ippidb/__init__.py @@ -0,0 +1,20 @@ +""" +This is the main ippidb module + +.. autosummary:: + :toctree: _autosummary + + admin + apps + forms + gx + models + tests + urls + utils + views + ws + management + migrations + templatetags +"""