Skip to content

Commit f795eba

Browse files
committed
feat: add conf.py
1 parent 7b5dee9 commit f795eba

File tree

3 files changed

+227
-1
lines changed

3 files changed

+227
-1
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@ html/
33
.vscode
44
_build
55
.DS_Store
6-
conf.py
76
preview_build/build

conf.py

+226
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
#!/usr/bin/env python3
2+
# -*- coding: utf-8 -*-
3+
4+
# -- PROJECT Variables ----------------------------------------------------
5+
settings_project_name = 'Manuale operativo di design - Designers Italia'
6+
settings_copyright_copyleft = "CC-BY 4.0 - Dipartimento per la trasformazione digitale e AgID - Agenzia per l'Italia Digitale"
7+
settings_editor_name = "Dipartimento per la trasformazione digitale e AgID - Agenzia per l'Italia Digitale"
8+
settings_file_name = 'Manuale-operativo-design'
9+
10+
import sys
11+
import os
12+
13+
import docs_italia_theme
14+
15+
# Add any Sphinx extension module names here, as strings. They can be
16+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
17+
# ones.
18+
extensions = [
19+
'sphinx.ext.autodoc',
20+
'sphinx.ext.doctest',
21+
'sphinx.ext.intersphinx',
22+
'sphinx.ext.todo',
23+
'sphinx.ext.coverage',
24+
'sphinx.ext.ifconfig',
25+
'docs_italia_theme'
26+
]
27+
28+
# Add any paths that contain templates here, relative to this directory.
29+
#templates_path = ['_templates']
30+
31+
# The suffix of source filenames.
32+
source_suffix = '.rst'
33+
34+
# The encoding of source files.
35+
#source_encoding = 'utf-8-sig'
36+
source_encoding = 'utf-8'
37+
38+
# The master toctree document.
39+
master_doc = 'index'
40+
41+
# General information about the project.
42+
project = settings_project_name
43+
copyright = settings_copyright_copyleft
44+
45+
# The version info for the project you're documenting, acts as replacement for
46+
# |version| and |release|, also used in various other places throughout the
47+
# built documents.
48+
#
49+
# The short X.Y version.
50+
version = ''
51+
# The full version, including alpha/beta/rc tags.
52+
release = ''
53+
54+
# The language for content autogenerated by Sphinx. Refer to documentation
55+
# for a list of supported languages.
56+
#language = None
57+
language = 'it'
58+
59+
# There are two options for replacing |today|: either, you set today to some
60+
# non-false value, then it is used:
61+
#today = ''
62+
# Else, today_fmt is used as the format for a strftime call.
63+
#today_fmt = '%B %d, %Y'
64+
65+
# List of patterns, relative to source directory, that match files and
66+
# directories to ignore when looking for source files.
67+
exclude_patterns = ['.DS_Store', '.venv', ]
68+
69+
# The name of the Pygments (syntax highlighting) style to use.
70+
pygments_style = 'sphinx'
71+
72+
# -- ReadTheDoc requirements and local template generation---------------------
73+
74+
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
75+
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
76+
77+
if on_rtd: # only import and set the theme if we're building docs locally
78+
html_context = {
79+
'css_files': [
80+
'_static/css/theme.css',
81+
'_static/css/badge_only.css',
82+
],
83+
}
84+
85+
# -- Options for HTML output ----------------------------------------------
86+
master_doc = 'index'
87+
html_theme = 'docs_italia_theme'
88+
html_theme_path = [docs_italia_theme.get_html_theme_path()]
89+
numfig = True
90+
91+
# The name for this set of Sphinx documents. If None, it defaults to
92+
# "<project> v<release> documentation".
93+
html_title = settings_project_name
94+
95+
# A shorter title for the navigation bar. Default is the same as html_title.
96+
#html_short_title = None
97+
98+
# The name of an image file (relative to this directory) to place at the top
99+
# of the sidebar.
100+
#html_logo = "images/logo.png"
101+
102+
# The name of an image file (within the static path) to use as favicon of the
103+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
104+
# pixels large.
105+
#html_favicon = None
106+
107+
# Add any paths that contain custom static files (such as style sheets) here,
108+
# relative to this directory. They are copied after the builtin static files,
109+
# so a file named "default.css" will overwrite the builtin "default.css".
110+
#html_static_path = ['_static']
111+
112+
# Add any extra paths that contain custom files (such as robots.txt or
113+
# .htaccess) here, relative to this directory. These files are copied
114+
# directly to the root of the documentation.
115+
#html_extra_path = []
116+
117+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
118+
# using the given strftime format.
119+
html_last_updated_fmt = '%d/%m/%Y'
120+
121+
# If true, SmartyPants will be used to convert quotes and dashes to
122+
# typographically correct entities.
123+
#html_use_smartypants = True
124+
125+
# Custom sidebar templates, maps document names to template names.
126+
#html_sidebars = {}
127+
128+
# Additional templates that should be rendered to pages, maps page names to
129+
# template names.
130+
#html_additional_pages = {}
131+
132+
# If false, no module index is generated.
133+
#html_domain_indices = True
134+
135+
# If false, no index is generated.
136+
#html_use_index = True
137+
138+
# If true, the index is split into individual pages for each letter.
139+
#html_split_index = False
140+
141+
# If true, links to the reST sources are added to the pages.
142+
#html_show_sourcelink = True
143+
144+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
145+
#html_show_sphinx = True
146+
147+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
148+
# html_show_copyright = True
149+
150+
# If true, an OpenSearch description file will be output, and all pages will
151+
# contain a <link> tag referring to it. The value of this option must be the
152+
# base URL from which the finished HTML is served.
153+
#html_use_opensearch = ''
154+
155+
# This is the file name suffix for HTML files (e.g. ".xhtml").
156+
#html_file_suffix = None
157+
158+
# Output file base name for HTML help builder.
159+
htmlhelp_basename = settings_file_name + 'doc'
160+
161+
162+
# -- Options for LaTeX output ---------------------------------------------
163+
164+
latex_elements = {
165+
# The paper size ('letterpaper' or 'a4paper').
166+
#'papersize': 'a4paper',
167+
168+
# The font size ('10pt', '11pt' or '12pt').
169+
#'pointsize': '10pt',
170+
171+
# Additional stuff for the LaTeX preamble.
172+
#'preamble': '',
173+
}
174+
175+
# Grouping the document tree into LaTeX files. List of tuples
176+
# (source start file, target name, title,
177+
# author, documentclass [howto, manual, or own class]).
178+
latex_documents = [
179+
('index', settings_file_name + '.tex', settings_project_name,
180+
settings_copyright_copyleft, 'manual'),
181+
]
182+
183+
# The name of an image file (relative to this directory) to place at the top of
184+
# the title page.
185+
#latex_logo = "images/..."
186+
187+
# For "manual" documents, if this is true, then toplevel headings are parts,
188+
# not chapters.
189+
#latex_use_parts = False
190+
191+
# If true, show page references after internal links.
192+
#latex_show_pagerefs = False
193+
194+
# If true, show URL addresses after external links.
195+
#latex_show_urls = False
196+
197+
# Documents to append as an appendix to all manuals.
198+
#latex_appendices = []
199+
200+
# If false, no module index is generated.
201+
#latex_domain_indices = True
202+
203+
204+
# -- Options for manual page output ---------------------------------------
205+
206+
# One entry per manual page. List of tuples
207+
# (source start file, name, description, authors, manual section).
208+
man_pages = [
209+
('index', settings_file_name, settings_project_name,
210+
[settings_editor_name], 1)
211+
]
212+
213+
# If true, show URL addresses after external links.
214+
#man_show_urls = False
215+
216+
217+
# -- Options for Texinfo output -------------------------------------------
218+
219+
# Grouping the document tree into Texinfo files. List of tuples
220+
# (source start file, target name, title, author,
221+
# dir menu entry, description, category)
222+
texinfo_documents = [
223+
('index', settings_file_name, settings_project_name,
224+
settings_copyright_copyleft, settings_project_name, settings_project_name,
225+
'Miscellaneous'),
226+
]

requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
git+https://github.com/italia/docs-italia-theme@bootstrap-italia

0 commit comments

Comments
 (0)