From 55876605eb4276f748c7d2e08da7906e6cd9c88a Mon Sep 17 00:00:00 2001 From: lhdamiani Date: Thu, 28 Oct 2021 16:43:35 +0200 Subject: [PATCH] readthedoc initialization --- docs/conf.py | 18 +++++++++--------- docs/index.rst | 5 +---- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index aa249ee..a13d1d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,8 +43,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Read the Docs Template' -copyright = u'2014, Read the Docs' +project = u'Std DAQ documentation' +copyright = u'2021, Paul Scherrer Institut' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -176,7 +176,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'ReadtheDocsTemplatedoc' +htmlhelp_basename = 'StdDAQDoc' # -- Options for LaTeX output --------------------------------------------- @@ -196,8 +196,8 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation', - u'Read the Docs', 'manual'), + ('index', 'StdDAQDocumentationTemplate.tex', u'Std DAQ Documentation', + u'Std DAQ documentation', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -226,8 +226,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'readthedocstemplate', u'Read the Docs Template Documentation', - [u'Read the Docs'], 1) + ('index', 'stddaqdocumentationtemplate', u'Std DAQ Documentation', + [u'Std DAQ documentation'], 1) ] # If true, show URL addresses after external links. @@ -240,8 +240,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation', - u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.', + ('index', 'StdDAQDoc', u'Std DAQ Documentation', + u'Std DAQ Documentation', 'StdDAQDocumentationTemplate', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/index.rst b/docs/index.rst index e52fb8e..bcdc366 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,4 @@ -.. Read the Docs Template documentation master file, created by - sphinx-quickstart on Tue Aug 26 14:19:49 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. Std DAQ documentation Welcome to Standard DAQ documentation! ==================================================