From e39615fccb7270bbb13b207b2b05bdea1d32d631 Mon Sep 17 00:00:00 2001 From: GiulioRossetti Date: Tue, 14 May 2024 10:56:32 +0200 Subject: [PATCH] :memo: rtd --- docs/Makefile | 2 +- docs/conf.py | 52 +++++++++++++++++++++++++-------------------------- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index a2c454a6..a8ab1680 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,7 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -SPHINXPROJ = NClib +SPHINXPROJ = CDlib SOURCEDIR = . BUILDDIR = _build diff --git a/docs/conf.py b/docs/conf.py index 3a564372..f00b72d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -114,15 +114,15 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.7.5' +needs_sphinx = '1.7.5' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -# autodoc_default_options = { -# 'autosummary': True, -# } +autodoc_default_options = { + 'autosummary': True, +} extensions = [ @@ -157,9 +157,9 @@ # built documents. # # The short X.Y version. -version = "0.3.1" +#version = "0.3.1" # The full version, including alpha/beta/rc tags. -release = "0.3.1" +#release = "0.3.1" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -323,9 +323,9 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, "CDlib.tex", "CDlib Documentation", "Giulio Rossetti", "manual") -] +#latex_documents = [ +# (master_doc, "CDlib.tex", "CDlib Documentation", "Giulio Rossetti", "manual") +#] # The name of an image file (relative to this directory) to place at the top of # the title page. @@ -352,7 +352,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "CDlib", "CDlib Documentation", [author], 1)] +#man_pages = [(master_doc, "CDlib", "CDlib Documentation", [author], 1)] # If true, show URL addresses after external links. # man_show_urls = False @@ -363,17 +363,17 @@ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "CDlib", - "CDlib Documentation", - author, - "CDlib", - "Community Discovery Library", - "Miscellaneous", - ) -] +#texinfo_documents = [ +# ( +# master_doc, +# "CDlib", +# "CDlib Documentation", +# author, +# "CDlib", +# "Community Discovery Library", +# "Miscellaneous", +# ) +#] # Documents to append as an appendix to all manuals. # texinfo_appendices = [] @@ -391,10 +391,10 @@ # -- Options for Epub output ---------------------------------------------- # Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright +#epub_title = project +#epub_author = author +#epub_publisher = author +#epub_copyright = copyright # The basename for the epub file. It defaults to the project name. # epub_basename = project @@ -434,7 +434,7 @@ # epub_post_files = [] # A list of files that should not be packed into the epub file. -epub_exclude_files = ["search.html"] +#epub_exclude_files = ["search.html"] # The depth of the table of contents in toc.ncx. # epub_tocdepth = 3