From 21ba8106522cf233b7387846043e57ab6ff08aa4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20B=C3=B6ckenhoff=20=28Laptop=29?= <dboe@ipp.mpg.de> Date: Fri, 11 Oct 2019 23:47:04 +0200 Subject: [PATCH] documentation automization added --- README.md | 1 - docs/Makefile | 1 + docs/README.md | 1 + docs/conf.py | 1 + docs/index.rst | 1 + tfields/__about__.py | 4 ++-- 6 files changed, 6 insertions(+), 3 deletions(-) create mode 120000 docs/Makefile create mode 120000 docs/README.md create mode 120000 docs/conf.py create mode 120000 docs/index.rst diff --git a/README.md b/README.md index 22bc8ff..ce5e30a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -``` # Installation ## Requirements * python versions >=2.7 or >=3.0 diff --git a/docs/Makefile b/docs/Makefile new file mode 120000 index 0000000..d273f32 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1 @@ +../make/python/docs/Makefile \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 120000 index 0000000..8ccad39 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +../make/python/docs/conf.py \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 120000 index 0000000..a629f4c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1 @@ +../make/python/docs/index.rst \ No newline at end of file diff --git a/tfields/__about__.py b/tfields/__about__.py index ed112ac..b4fe524 100644 --- a/tfields/__about__.py +++ b/tfields/__about__.py @@ -4,7 +4,7 @@ Description of project with title, state and further constants import os __all__ = [ "__version__", - "__title__", + # "__title__", "__summary__", "__keywords__", "__uri__", @@ -18,7 +18,7 @@ __all__ = [ ] __version__ = '0.1.4' -__title__ = os.path.basename(os.path.abspath('.')) +# __title__ = os.path.basename(os.path.abspath('.')) # problematic __summary__ = "numpy + sympy implementation of tensor fields with attached coordinate systems" __keywords__ = "tensors coordinate system trafo sympy numpy" __uri__ = 'https://gitlab.mpcdf.mpg.de/dboe/tfields' -- GitLab