From 4d38b4905feed8725bde48309019c69a5bc3ffcb Mon Sep 17 00:00:00 2001 From: Florent Becker Date: Tue, 21 Sep 2021 17:11:06 +0200 Subject: [PATCH] fix --- README.rst | 26 +++++++ requirements.txt | 23 +++++++ source/conf.py | 174 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 223 insertions(+) create mode 100644 README.rst create mode 100644 requirements.txt create mode 100644 source/conf.py diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..ebde17a --- /dev/null +++ b/README.rst @@ -0,0 +1,26 @@ +# Exemple pour des énoncés utilisant le module de test de code pour sphinx. + + +## Installation : + +* Installer virtualenv + +* Cloner le dépot :: + + git clone https://gitlab.com/jrobert/easySphinx.git + + +* Créer un virtualenv et l'activer :: + + virtualenv -p python3 venv + source venv/bin/activate + +* Installer les dépendances :; + + (venv)$ pip install -r requirements.txt + + +* Compiler :: + + make html + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..209288e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,23 @@ +alabaster==0.7.12 +Babel==2.6.0 +certifi==2018.10.15 +chardet==3.0.4 +docutils==0.14 +idna==2.7 +imagesize==1.1.0 +Jinja2==2.10 +jsonpickle==1.0 +MarkupSafe==1.1.0 +packaging==18.0 +psutil==5.4.8 +Pygments==2.2.0 +pyparsing==2.3.0 +pytz==2018.7 +requests==2.20.1 +six==1.11.0 +snowballstemmer==1.2.1 +Sphinx==1.8.2 +-e git+https://gitlab.com/FlorentBecker2/sphinx-easypython.git@auto_hypothesis#egg=sphinx_easypython +sphinxcontrib-websupport==1.1.0 +urllib3==1.24.1 +importlib-resources==1.4.0 diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..4bfd7d0 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,174 @@ +# -*- 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 = 'Projet 2000' +copyright = '2018, fbecker' +author = 'fbecker' + +# 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-easypython', +] + +# 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 = 'fr' + +# 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 = '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 = 'DemonstrationExerciseurdoc' + + +# -- 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, 'DemonstrationExerciseur.tex', 'Demonstration Exerciseur Documentation', + 'jrobert', '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, 'demonstrationexerciseur', 'Demonstration Exerciseur 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, 'DemonstrationExerciseur', 'Demonstration Exerciseur Documentation', + author, 'DemonstrationExerciseur', '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']