Skip to content

conf.py minor cleanups #556

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

Closed
kloczek wants to merge 3 commits into from
+13 −12
Closed

conf.py minor cleanups #556

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
914463b
Allow build documentation out of only source tree
kloczek Aug 31, 2023
1d6bfb9
Use master_doc instead "index"
kloczek Aug 31, 2023
31ac387
declare author and add use project and copyright
kloczek Aug 31, 2023
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
Prev Previous commit
declare author and add use project and copyright 
Declare author variable and add use already declared project and copyright.

Signed-off-by: Tomasz Kłoczko <kloczek@github.com>
  • Loading branch information
@kloczek
kloczek committed Aug 31, 2023
commit 31ac387198b0e00898112100a6b54cc118065aaf
21 changes: 11 additions & 10 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@

# General information about the project.
project = "msgpack"
copyright = "Inada Naoki"
copyright = "2013, Inada Naoki"
author = "Inada Naoki"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -181,7 +182,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
(master_doc, "msgpack.tex", "msgpack Documentation", "Author", "manual"),
(master_doc, "msgpack.tex", "msgpack Documentation", author, "manual"),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -209,7 +210,7 @@

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "msgpack", "msgpack Documentation", ["Author"], 1)]
man_pages = [(master_doc, project, "msgpack Documentation", author, 1)]

# If true, show URL addresses after external links.
# man_show_urls = False
Expand All @@ -223,10 +224,10 @@
texinfo_documents = [
(
master_doc,
"msgpack",
project,
"msgpack Documentation",
"Author",
"msgpack",
author,
project,
"One line description of project.",
"Miscellaneous",
),
Expand All @@ -245,10 +246,10 @@
# -- Options for Epub output ---------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = "msgpack"
epub_author = "Author"
epub_publisher = "Author"
epub_copyright = "2013, Author"
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The language of the text. It defaults to the language option
# or en if the language is not set.
Expand Down