Skip to content

Commit

Permalink
Improve documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ynikitenko committed Apr 13, 2020
1 parent 82e2f35 commit a2fda5b
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 13 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
30 changes: 19 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 *<path-to-lena>* with the actual path to the directory *lena*
and write
and add

.. code-block:: console
Expand Down
1 change: 0 additions & 1 deletion lena/core/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""Lena combines calculations using *sequences*.
*Sequences* consist of *elements*.
Basic Lena sequences and element types are defined in this module.
"""
Expand Down

0 comments on commit a2fda5b

Please sign in to comment.