Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update installation #131

Merged
merged 1 commit into from
Nov 30, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,6 @@
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------
# -- Extension configuration -------------------------------------------------
todo_include_todos = True
napoleon_include_init_with_doc = True
8 changes: 8 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,11 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Documentation TODO
==================
These are the missing parts of the documentation

.. todolist::

27 changes: 23 additions & 4 deletions doc/installation.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,41 @@
Installation
============

For inexperienced windows users it is recommended to use a prepackaged
python distribution that contains the required packages. One excellent
option for Windows users is `Anaconda <http://continuum.io/>`__
As a basic requirement is python > 3.5

Windows
-------
.. todo::
Update to use winpython


Install for normal users
------------------------
Once the python environment is installed just run ::

>> pip install emva1288


Development
------------
If you want to contribute to this project, clone it and install it::

>> git clone https://github.com/EMVA1288/emva1288.git (or from a fork)
>> python setup.py develop
>> pip install -e .[doc]

If you make code modifications, you can run the unittests to make sure
nothing important is broken::

>> python tests.py

This will run the test suite and print the code coverage in the console.

Documentation
-------------
To rebuild the documentation::

>> cd doc
>> make clean
>> make html