Adding banner to README

[alex4200]

Context

Adding a banner to the README in preparation for adding this tool to the morphology suite

[mgeplf]

I'll look at why the CI is failing

[mgeplf]

It fails due to not finding the new banner:

  Warning, treated as error:
  ../README.rst:322:image file not readable: doc/source/logo/BBP-Morph-Tool.jpg
  make: *** [Makefile:29: html] Error 2
  Error: ERROR: InvocationError for command /usr/bin/make html SPHINXOPTS=-W (exited with code 2)

We should probably re-organize the docs, so the landing page has a brief description, and points to the readthedocs for the main documentation.

[alex4200]

Locally it did work. And why does the python 3.9 check succeed, but not the other ones?

[adrien-berchet]

@alex4200 : The doc is only build with py38. @mgeplf : what about just changing the .. include directive in the index.rst file? We could have this for example:

.. image:: logo/BBP-Morph-Tool.jpg

.. include:: ../../README.rst
    :start-line: 2 

.. toctree::
   :hidden:

   Home <self>
   morphdb
   api
   changelog

EDIT: The README must also be changed by removing the substitution to make it work: the 1st line should just be .. image:: doc/source/logo/BBP-Morph-Tool.jpg and the line 322 should be removed.

[mgeplf]

Didn't know about the start-line 'work around'; neat.

I think reorg of the docs is still worth it; to be more inline w/ neurom; covering the soma intracacies on the github page seems like too much info. Using the work-around in the meantime makes sense; can you give it a shot @alex4200 ?

[alex4200]

But still, the error message

file not readable: doc/source/logo/BBP-Morph-Tool.jpg

does not make sense, as that file does exist!

[adrien-berchet]

But still, the error message

file not readable: doc/source/logo/BBP-Morph-Tool.jpg

does not make sense, as that file does exist!

The doc is built using tox which changes the working directory. It works for you because you probably don't use tox to build the doc.

[alex4200]

But the file is there! See pull-request 96.

I do not understand why an existing file is not found.

[adrien-berchet]

But the file is there! See pull-request 96.

I do not understand why an existing file is not found.

Because of this in tox.ini:

[testenv:docs]
changedir = doc

I can update the branch if you wish.

[alex4200]

Ah I see. Let me try to fix this.

[adrien-berchet]

LGTM now. Is it ok for you @mgeplf ?

[mgeplf]

I had the same changes :)

Nice workaround, thanks for that - didn't know that existed. Cheers.

[adrien-berchet]

You're welcome :)

[mgeplf]

Thanks @alex4200 and @adrien-berchet