From a2fda5b8e84a597d81b6c06e903c76e237202339 Mon Sep 17 00:00:00 2001 From: Yaroslav Nikitenko Date: Mon, 13 Apr 2020 17:18:22 +0300 Subject: [PATCH] Improve documentation. --- README.rst | 2 +- docs/source/index.rst | 30 +++++++++++++++++++----------- lena/core/__init__.py | 1 - 3 files changed, 20 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 7da6b5e..13a479e 100644 --- a/README.rst +++ b/README.rst @@ -4,4 +4,4 @@ Lena Lena is an architectural framework for data analysis. It is written in Python and works with Python versions 2, 3 and PyPy. -For more information on the framework and its installation see the documentation in the *docs/* subdirectory or online at https://lena.readthedocs.io +For more information on the framework and its installation see the documentation at https://lena.readthedocs.io diff --git a/docs/source/index.rst b/docs/source/index.rst index f14c244..0c6ce68 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -48,28 +48,36 @@ Lena originated from experimental neutrino physics and is named after a great Si Installation ------------ -.. - From pip - ^^^^^^^^ - Lena core modules depend only on Python standard libraries. - Other python dependencies are installed automatically from pip:: - pip install lena +From pip +^^^^^^^^ +Lena core modules depend only on Python standard libraries. +Other python extensions can be installed from pip: + +:: + + pip install lena + # if you plan to render LaTeX templates + pip install jinja2 - # without jinja2 - pip install --no-deps lena - # or, for Python 3 - pip3 install lena +.. + # without jinja2 + # unfortunately, now jinja2 seems to be not + # in the default requirements. + pip install --no-deps lena + # or, for Python 3 + pip3 install lena From github ^^^^^^^^^^^ :: git clone https://github.com/ynikitenko/lena + # most of requirements are for development only pip install -r lena/requirements.txt Replace ** with the actual path to the directory *lena* -and write +and add .. code-block:: console diff --git a/lena/core/__init__.py b/lena/core/__init__.py index ee5e69e..45b559a 100644 --- a/lena/core/__init__.py +++ b/lena/core/__init__.py @@ -1,5 +1,4 @@ """Lena combines calculations using *sequences*. - *Sequences* consist of *elements*. Basic Lena sequences and element types are defined in this module. """