From 1ca0575a0633d281b9dc2ca10b7c0ad2fded86a7 Mon Sep 17 00:00:00 2001 From: Alban Gruin Date: Sun, 22 Apr 2018 18:42:14 +0200 Subject: doc: finalisation --- Documentation/conf.py | 99 +++++------------------------------------ Documentation/dev/internals.rst | 3 -- Documentation/index.rst | 1 - 3 files changed, 11 insertions(+), 92 deletions(-) delete mode 100644 Documentation/dev/internals.rst (limited to 'Documentation') diff --git a/Documentation/conf.py b/Documentation/conf.py index bfd8e6a..69020ab 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -1,114 +1,40 @@ # -*- coding: utf-8 -*- -# -# celcatsanitizer documentation build configuration file, created by -# sphinx-quickstart on Mon Apr 16 12:10:54 2018. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# 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('.')) - - -# -- 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 = [] -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +from datetime import datetime -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] +extensions = [] +templates_path = ['_templates'] source_suffix = '.rst' - -# The master toctree document. master_doc = 'index' +todo_include_todos = False # General information about the project. project = u'celcatsanitizer' -copyright = u'2018, Alban Gruin' +year = datetime.now().year +copyright = u'%d, Alban Gruin' % year author = u'Alban Gruin' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. version = u'dev' -# The full version, including alpha/beta/rc tags. release = u'dev' -# 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 = 'fr' -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -# The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- 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. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ 'about.html', 'navigation.html', - 'relations.html', # needs 'show_related': True theme option to display - 'searchbox.html', ] } +html_theme_options = { + 'description': "Un outil pour reformater les emplois du temps de Celcat", + 'extra_nav_links': {"Sources": + "https://git.pa1ch.fr/alban/celcatsanitizer"}, +} # -- Options for HTMLHelp output ------------------------------------------ @@ -165,6 +91,3 @@ texinfo_documents = [ author, 'celcatsanitizer', 'One line description of project.', 'Miscellaneous'), ] - - - diff --git a/Documentation/dev/internals.rst b/Documentation/dev/internals.rst deleted file mode 100644 index 9800d06..0000000 --- a/Documentation/dev/internals.rst +++ /dev/null @@ -1,3 +0,0 @@ -========================================= -Fonctionnement interne de celcatsanitizer -========================================= diff --git a/Documentation/index.rst b/Documentation/index.rst index c9e0b2a..992db09 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -73,5 +73,4 @@ Développement dev/contribute dev/xml - dev/internals dev/roadmap -- cgit v1.2.1