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
wants to merge 3 commits into from
Closed

conf.py minor cleanups #556

Changes from all commits
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
25 changes: 13 additions & 12 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(".."))
Copy link
Contributor

@ThomasWaldmann ThomasWaldmann Aug 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you see the commit comment in my "sphinx-related work" PR? #554

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you see the commit comment in my "sphinx-related work" PR? #554

Nope .. just checked those comments.
Still without that tweak which it is not possible to build documentation without have module installed.
This kind of situation is when for example rpm package is build from non-root account and when it is not possible to install anything outside build tree.

In your commit tweaking sys.path still remains commented (only space is removed).
Even on generate documentation in CI it should help because it will be not necessary to install module.

If you don't lika that part just cherry pick PR with skipping that commit ..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still without that tweak which it is not possible to build documentation without have module installed.

Doesn't it mean you build doc from pure Python fallback, instead of Cython build?
Do you confirm that docs build from Cython code and pure Python fallback are completely same?


# -- General configuration -----------------------------------------------------

Expand All @@ -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 = [
("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
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 = [("index", "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 @@ -222,11 +223,11 @@
# dir menu entry, description, category)
texinfo_documents = [
(
"index",
"msgpack",
master_doc,
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