diff --git a/gen_doc.sh b/gen_doc.sh index 50d8207..3ab49c6 100755 --- a/gen_doc.sh +++ b/gen_doc.sh @@ -1,11 +1,7 @@ #!/bin/bash -# -# if pdoc is missing: pip install pdoc3 -# +pip install -U pdoc -[ -d doc.old ] && rm -r doc.old -[ -d doc ] && mv doc doc.old -pdoc -f --html odfdo -mv html/odfdo doc -mv html doc.old +[ -d doc ] && rm -fr doc +mkdir doc cp odfdo.png doc +pdoc -o doc --search --logo "https://raw.githubusercontent.com/jdum/odfdo/master/odfdo.png" --logo-link "https://github.com/jdum/odfdo" ./odfdo diff --git a/odfdo/__init__.py b/odfdo/__init__.py index 521baef..33a8667 100644 --- a/odfdo/__init__.py +++ b/odfdo/__init__.py @@ -20,7 +20,9 @@ # Authors: David Versmisse # Hervé Cauwelier # Romain Gauthier -"""Python library for OpenDocument Format (ODF)""" +""" +.. include:: ../README.md +""" __all__ = [ "AnimPar", diff --git a/pyproject.toml b/pyproject.toml index 3e54682..e606106 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -30,7 +30,7 @@ python = ">=3.9,<4" lxml = "^5" [tool.poetry.group.docs.dependencies] -pdoc3 = ">=0.10" +pdoc = ">=14.4.0" [tool.poetry.group.dev.dependencies] poetry = "~1.8"