From 914463be2226a5d2ef861941f594e79e854ac0c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20K=C5=82oczko?= Date: Thu, 31 Aug 2023 10:45:01 +0000 Subject: [PATCH 1/3] Allow build documentation out of only source tree MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Uncomment line from tempate conf.py which allows build module documentation out of only source tree without have `msgpack` module installed. This will prevent as well building documetation against installed module whch mey be different version than what is in source tree. Signed-off-by: Tomasz Kłoczko --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 1c1895c7..3bd4c69b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,7 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ----------------------------------------------------- From 1d6bfb9b0c33ccf59ad8fbd2fd59fe33ceaa594c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20K=C5=82oczko?= Date: Thu, 31 Aug 2023 10:50:00 +0000 Subject: [PATCH 2/3] Use master_doc instead "index" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Use already declared master_doc instead "index". Signed-off-by: Tomasz Kłoczko --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 3bd4c69b..62967a94 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -181,7 +181,7 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ("index", "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 @@ -209,7 +209,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [("index", "msgpack", "msgpack Documentation", ["Author"], 1)] +man_pages = [(master_doc, "msgpack", "msgpack Documentation", ["Author"], 1)] # If true, show URL addresses after external links. # man_show_urls = False @@ -222,7 +222,7 @@ # dir menu entry, description, category) texinfo_documents = [ ( - "index", + master_doc, "msgpack", "msgpack Documentation", "Author", From 31ac387198b0e00898112100a6b54cc118065aaf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20K=C5=82oczko?= Date: Thu, 31 Aug 2023 10:54:43 +0000 Subject: [PATCH 3/3] declare author and add use project and copyright MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Declare author variable and add use already declared project and copyright. Signed-off-by: Tomasz Kłoczko --- docs/conf.py | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 62967a94..e27da6fc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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 @@ -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 @@ -223,10 +224,10 @@ texinfo_documents = [ ( master_doc, - "msgpack", + project, "msgpack Documentation", - "Author", - "msgpack", + author, + project, "One line description of project.", "Miscellaneous", ), @@ -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.