Skip to content

Commit

Permalink
Add badges to readme and repo link in docs (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
haleepfl committed Apr 16, 2020
1 parent a5f2136 commit ef6ac35
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
|banner|

|build_status| |license| |coverage| |docs|

Blue Brain SNAP
===============

Expand All @@ -8,8 +10,6 @@ Blue Brain Simulation and Neural network Analysis Productivity layer (Blue Brain
Blue Brain SNAP is a Python library for accessing BlueBrain circuit models represented in
`SONATA <https://github.com/AllenInstitute/sonata/blob/master/docs/SONATA_DEVELOPER_GUIDE.md>`__ format.

|build_status| |coverage|

Installation
------------

Expand Down Expand Up @@ -87,10 +87,17 @@ Refer to `COPYING.LESSER <https://github.com/BlueBrain/snap/blob/master/COPYING.
:target: https://travis-ci.com/BlueBrain/snap
:alt: Build Status

.. |license| image:: https://img.shields.io/pypi/l/bluepysnap
:target: https://github.com/BlueBrain/snap/blob/master/COPYING.LESSER

.. |coverage| image:: https://codecov.io/github/BlueBrain/snap/coverage.svg?branch=master
:target: https://codecov.io/github/BlueBrain/snap?branch=master
:alt: codecov.io

.. |docs| image:: https://readthedocs.org/projects/bluebrainsnap/badge/?version=latest
:target: https://bluebrainsnap.readthedocs.io/
:alt: documentation status

.. substitutions
.. |banner| image:: doc/source/_images/BlueBrainSNAP.jpg
.. |circuit| replace:: **Circuit**
Expand Down
6 changes: 6 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@
# hide source links
html_show_sourcelink = False

# set the theme settings
html_theme_options = {
"repo_url": "https://github.com/BlueBrain/snap/",
"repo_name": "BlueBrain/snap"
}

# autodoc settings
autodoc_default_options = {
"members": True,
Expand Down

0 comments on commit ef6ac35

Please sign in to comment.