Projet

Général

Profil

Anomalie #1302 » 0001-Add-yml-rtd-configuration-file-and-clean-useless-opt.patch

Guillaume AGNIERAY, 28/09/2019 10:29

Voir les différences:

readthedocs.yml
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: source/conf.py
fail_on_warning: false
# Optionally build your docs in additional formats such as PDF and ePub
formats: all
# Optionnaly set the Docker image used for building the docs.
build:
image: stable
# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
requirements.txt
sphinx
rst2pdf
source/_styles/templates/galette_cover.tmpl
.. footer::
#{title} | © 2011 The Galette Team | Page ###Page### sur ###Total###
.. role:: normal
.. raw:: pdf
Spacer 0 5cm
.. image:: _styles/static/images/galette.png
:width: 3in
<?py if title: ?>
.. cssclass:: title
#{title}
<?py #end ?>
<?py if subtitle: ?>
.. cssclass:: subtitle
#{subtitle}
<?py #end ?>
.. raw:: pdf
Spacer 0 3cm
<?py for author in authors: ?>
.. cssclass:: author
#{author}
<?py #end ?>
.. raw:: pdf
Spacer 0 3cm
.. cssclass:: author
:normal:`#{date}`
.. raw:: pdf
PageBreak
source/conf.py
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for PDF output --------------------------------------------------
#Grouping the document tree into PDF files. List of tuples
#(source start file, target name, title, author, options).
#If there is more than one author, separate them with \\.
#For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
#The options element is a dictionary that lets you override
#this config per-document.
#For example,
#('index', u'MyProject', u'My Project', u'Author Name',
#dict(pdf_compressed = True))
#would mean that specific document would be compressed
#regardless of the global pdf_compressed setting.
pdf_documents = [
('index', u'galette', u'Documentation de Galette', u'Johan Cwiklinski'),
('usermanual/index', u'usermanual', u'Manuel Utilisateur de Galette', u'Johan Cwiklinski'),
('installation/index', u'installation', u'Installation de Galette', u'Johan Cwiklinski'),
('plugins/index', u'plugins', u'Plugins de Galette', u'Johan Cwiklinski'),
]
# A comma-separated list of custom stylesheets. Example:
pdf_stylesheets = ['sphinx','kerning','a4']
# Create a compressed PDF
# Use True/False or 1/0
# Example: compressed=True
pdf_compressed = True
# A colon-separated list of folders to search for fonts. Example:
# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
# Language to be used for hyphenation support
pdf_language = "fr_FR"
# Mode for literal blocks wider than the frame. Can be
# overflow, shrink or truncate
#pdf_fit_mode = "shrink"
# Section level that forces a break page.
# For example: 1 means top-level sections start in a new page
# 0 means disabled
pdf_break_level = 2
# When a section starts in a new page, force it to be 'even', 'odd',
# or just use 'any'
#pdf_breakside = 'any'
# Insert footnotes where they are defined instead of
# at the end.
#pdf_inline_footnotes = True
# verbosity level. 0 1 or 2
#pdf_verbosity = 0
# If false, no index is generated.
#pdf_use_index = True
# If false, no modindex is generated.
#pdf_use_modindex = False
# If false, no coverpage is generated.
#pdf_use_coverpage = True
# Name of the cover page template to use
#pdf_cover_template = 'sphinxcover.tmpl'
pdf_cover_template = '_styles/templates/galette_cover.tmpl'
# Documents to append as an appendix to all manuals.
#pdf_appendices = []
# Enable experimental feature to split table cells. Use it
# if you get "DelayedTable too big" errors
#pdf_splittables = False
# Set the default DPI for images
#pdf_default_dpi = 72
# Enable rst2pdf extension modules (default is empty list)
# you need vectorpdf for better sphinx's graphviz support
#pdf_extensions = ['vectorpdf']
pdf_extensions = ['dotted_toc']
# Page template name for "regular" pages
#pdf_page_template = 'cutePage'
(7-7/8)