Tempalte improvements

This commit is contained in:
Dirk Alders 2025-08-14 22:43:37 +02:00
parent a8341df13e
commit e61dbc130c
2 changed files with 13 additions and 13 deletions

View File

@ -104,7 +104,7 @@ html_static_path = ['_static']
# -- Options for HTMLHelp output --------------------------------------------- # -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'cachingdoc' htmlhelp_basename = 'moduledoc'
# -- Options for LaTeX output ------------------------------------------------ # -- Options for LaTeX output ------------------------------------------------
@ -130,20 +130,20 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ #latex_documents = [
(master_doc, 'caching.tex', 'socket\\_protocol Documentation', # (master_doc, 'caching.tex', 'socket\\_protocol Documentation',
'Dirk Alders', 'manual'), # 'Dirk Alders', 'manual'),
] #]
# -- Options for manual page output ------------------------------------------ # -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ #man_pages = [
(master_doc, 'caching', 'caching Documentation', # (master_doc, 'caching', 'caching Documentation',
[author], 1) # [author], 1)
] #]
# -- Options for Texinfo output ---------------------------------------------- # -- Options for Texinfo output ----------------------------------------------
@ -152,8 +152,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'caching', 'caching Documentation', (master_doc, '<module_name>', '<module_name> Documentation',
author, 'caching', 'One line description of project.', author, '<module_name>', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

View File

@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to cachings's documentation! Welcome to <module_name> documentation!
==================================== =======================================
.. automodule:: <module_name> .. automodule:: <module_name>
:members: :members: