Skip to content

Commit 054a5e3

Browse files
committed
🔬 Add Sphinx configuration
Changes the defaults from the template repository to specific strings for the Principles. Signed-off-by: Justin W. Flory <git@jwf.io>
1 parent 0267714 commit 054a5e3

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

docs/conf.py

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
# full list see the documentation:
77
# http://www.sphinx-doc.org/en/master/config
88

9+
import sphinx_rtd_theme
10+
911
# -- Path setup --------------------------------------------------------------
1012

1113
# If extensions (or modules to document with autodoc) are in another directory,
@@ -19,14 +21,18 @@
1921

2022
# -- Project information -----------------------------------------------------
2123

22-
project = 'sphinx-docs-opinionated-quickstart'
23-
copyright = '2018, Justin W. Flory'
24-
author = 'Justin W. Flory'
24+
project = 'Principles of Authentic Participation'
25+
copyright = '2020, Sustainers'
26+
author = "Justin W. Flory, " \
27+
"Duane O'Brien, " \
28+
"Kevin P. Fleming, " \
29+
"Alyssa Wright, " \
30+
"and others"
2531

2632
# The short X.Y version
27-
version = '1.0'
33+
version = '0.1'
2834
# The full version, including alpha/beta/rc tags
29-
release = '1.0.0'
35+
release = '0.0.1'
3036

3137

3238
# -- General configuration ---------------------------------------------------
@@ -40,6 +46,7 @@
4046
# ones.
4147
extensions = [
4248
'recommonmark',
49+
'sphinx_markdown_tables',
4350
'sphinx.ext.autodoc',
4451
'sphinx.ext.todo',
4552
'sphinx.ext.imgmath',
@@ -83,7 +90,6 @@
8390
# The theme to use for HTML and HTML Help pages. See the documentation for
8491
# a list of builtin themes.
8592
#
86-
import sphinx_rtd_theme
8793
html_theme = 'sphinx_rtd_theme'
8894
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
8995

@@ -115,7 +121,7 @@
115121
# -- Options for HTMLHelp output ---------------------------------------------
116122

117123
# Output file base name for HTML help builder.
118-
htmlhelp_basename = 'sphinx-docs-opinionated-quickstartdoc'
124+
htmlhelp_basename = 'authentic-participationdoc'
119125

120126

121127
# -- Options for LaTeX output ------------------------------------------------
@@ -142,7 +148,8 @@
142148
# (source start file, target name, title,
143149
# author, documentclass [howto, manual, or own class]).
144150
latex_documents = [
145-
(master_doc, 'sphinx-docs-opinionated-quickstart.tex', 'sphinx-docs-opinionated-quickstart Documentation',
151+
(master_doc, 'authentic-participation.tex',
152+
'Principles of Authentic Participation',
146153
'Justin W. Flory', 'manual'),
147154
]
148155

@@ -152,7 +159,8 @@
152159
# One entry per manual page. List of tuples
153160
# (source start file, name, description, authors, manual section).
154161
man_pages = [
155-
(master_doc, 'sphinx-docs-opinionated-quickstart', 'sphinx-docs-opinionated-quickstart Documentation',
162+
(master_doc, 'authentic-participation',
163+
'Principles of Authentic Participation',
156164
[author], 1)
157165
]
158166

@@ -163,8 +171,11 @@
163171
# (source start file, target name, title, author,
164172
# dir menu entry, description, category)
165173
texinfo_documents = [
166-
(master_doc, 'sphinx-docs-opinionated-quickstart', 'sphinx-docs-opinionated-quickstart Documentation',
167-
author, 'sphinx-docs-opinionated-quickstart', 'One line description of project.',
174+
(master_doc, 'authentic-participation',
175+
'Principles of Authentic Participation',
176+
author, 'authentic-participation',
177+
'Guidelines on how organizations and individuals can contribute'
178+
'authentically to open source projects and communities'
168179
'Miscellaneous'),
169180
]
170181

0 commit comments

Comments
 (0)