Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improved documentation configuration #324

Merged
merged 1 commit into from
Oct 10, 2023
Merged

improved documentation configuration #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@

# -- Project information -----------------------------------------------------

project = u'Bootstrap-Flask'
copyright = u'2017, Grey Li'
author = u'Grey Li'
project = 'Bootstrap-Flask'
copyright = '2017, Grey Li'
author = 'Grey Li'

version, release = get_version('Bootstrap-Flask')

Expand Down Expand Up @@ -63,7 +63,7 @@
# 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 = [u'_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand Down Expand Up @@ -107,8 +107,8 @@

# Output file base name for HTML help builder.
htmlhelp_basename = 'Bootstrap-Flaskdoc'
html_favicon = "_static/bootstrap-flask-favicon.png"
html_logo = "_static/bootstrap-flask-logo.png"
html_favicon = '_static/bootstrap-flask-favicon.png'
html_logo = '_static/bootstrap-flask-logo.png'

html_css_files = [
'css/custom.css',
Expand Down Expand Up @@ -137,8 +137,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Bootstrap-Flask.tex', u'Bootstrap-Flask Documentation',
u'Grey Li', 'manual'),
(master_doc, 'Bootstrap-Flask.tex', 'Bootstrap-Flask Documentation',
'Grey Li', 'manual'),
]


Expand All @@ -147,7 +147,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'bootstrap-flask', u'Bootstrap-Flask Documentation',
(master_doc, 'bootstrap-flask', 'Bootstrap-Flask Documentation',
[author], 1)
]

Expand All @@ -158,7 +158,7 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Bootstrap-Flask', u'Bootstrap-Flask Documentation',
(master_doc, 'Bootstrap-Flask', 'Bootstrap-Flask Documentation',
author, 'Bootstrap-Flask', 'One line description of project.',
'Miscellaneous'),
]
Expand Down
3 changes: 2 additions & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,5 @@ commands =
[testenv:docs]
deps =
-r requirements/docs.txt
commands = sphinx-build -W -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html
commands =
sphinx-build -W -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html
Loading