From 7c042b5641a5d9df49dfcbc70d6bece840cc203b Mon Sep 17 00:00:00 2001 From: Daniel <daniel@harvey> Date: Thu, 10 Dec 2020 10:50:50 +0100 Subject: [PATCH] WIP FIX: Recommonmark --- src/doc/conf.py | 16 ++++++++++------ unittests/docker/Dockerfile | 3 ++- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/src/doc/conf.py b/src/doc/conf.py index eecfa112..a91ed6b3 100644 --- a/src/doc/conf.py +++ b/src/doc/conf.py @@ -19,7 +19,7 @@ # -- Project information ----------------------------------------------------- -project = 'caosdb-pylib' +project = 'pycaosdb' copyright = '2020, IndiScale GmbH' author = 'Daniel Hornung' @@ -51,8 +51,12 @@ templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # -# source_suffix = ['.rst', '.md'] -# source_suffix = '.rst' +source_suffix = ['.rst', '.md'] +# source_suffix = { +# '.rst': 'restructuredtext', +# '.md': 'markdown', +# } + # The master toctree document. master_doc = 'index' @@ -142,7 +146,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'caosdb-pylib', 'caosdb-pylib Documentation', + (master_doc, 'pycaosdb', 'pycaosdb documentation', [author], 1) ] @@ -153,8 +157,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'caosdb-pylib', 'caosdb-pylib Documentation', - author, 'caosdb-pylib', 'One line description of project.', + (master_doc, 'pycaosdb', 'pycaosdb documentation', + author, 'pycaosdb', 'One line description of project.', 'Miscellaneous'), ] diff --git a/unittests/docker/Dockerfile b/unittests/docker/Dockerfile index 8b319084..1944c48e 100644 --- a/unittests/docker/Dockerfile +++ b/unittests/docker/Dockerfile @@ -3,7 +3,8 @@ RUN apt-get update && \ apt-get install -y \ pylint3 python3-pip tox git \ curl pycodestyle \ - python3-sphinx python3-recommonmark + python3-sphinx ARG COMMIT="dev" RUN git clone -b dev https://gitlab.com/caosdb/caosdb-pylib.git && \ cd caosdb-pylib && git checkout $COMMIT && pip3 install . +RUN pip3 install recommonmark -- GitLab