Merge pull request #134 from jpgill86/docs-updates

Update docs style, add badges and screenshot

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Samuel Garcia, Jeffrey Gill
+Copyright (c) 2021 Samuel Garcia, Jeffrey Gill
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -80,7 +80,7 @@ Check the docs for more [examples].
 [pypi]:                        https://pypi.org/project/ephyviewer
 [pypi-badge]:                  https://img.shields.io/pypi/v/ephyviewer.svg?logo=python&logoColor=white
 [rtd-status]:                  https://readthedocs.org/projects/ephyviewer
-[rtd-status-badge]:            https://readthedocs.org/projects/ephyviewer/badge/?version=latest
+[rtd-status-badge]:            https://img.shields.io/readthedocs/ephyviewer/latest.svg?logo=read-the-docs&logoColor=white
 
 [Documentation]: https://ephyviewer.readthedocs.io/en/latest/
 [Release Notes]: https://ephyviewer.readthedocs.io/en/latest/releasenotes.html

doc/conf.py

@@ -52,7 +52,7 @@
 
 # General information about the project.
 project = 'ephyviewer'
-copyright = '2019, Samuel Garcia, Jeffrey Gill'
+copyright = '2021, Samuel Garcia, Jeffrey Gill'
 author = 'Samuel Garcia, Jeffrey Gill'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -118,12 +118,17 @@
 #
 html_theme_options = {
     'description': 'Simple viewers for ephys signals, events, video and more',
+    'description_font_style': 'italic',
+    'font_family': 'Arial',
+    'page_width': '1200px',  # default is 940
+    'sidebar_width': '280px',  # default is 220
+    'show_relbars': True,
     'fixed_sidebar': True,
-    'github_user': 'NeuralEnsemble',
-    'github_repo': 'ephyviewer',
-    'github_button': True,
-    'github_type': 'watch', # watch, fork, follow, star
-    'github_count': False,
+    # 'github_user': 'NeuralEnsemble',
+    # 'github_repo': 'ephyviewer',
+    # 'github_button': True,
+    # 'github_type': 'watch', # watch, fork, follow, star
+    # 'github_count': False,
     # 'github_banner': True,
 }
 

doc/index.rst

@@ -1,20 +1,30 @@
-ephyviewer |version|
-====================
+**ephyviewer**
+==============
+
+*Simple viewers for ephys signals, events, video and more*
+
+|pypi-badge| |anaconda-cloud-badge| |github-badge| |conda-forge-feedstock-badge| |rtd-status-badge|
+
+**Version:** |version| (`other versions`_)
 
 Do you have a large neural/electrophysiological dataset? Do you want to closely
 examine the raw signals and other events before performing an in-depth analysis?
-Good news! ephyviewer is your friend.
+Good news! **ephyviewer** is your friend.
 
-ephyviewer is both a standalone application and a Python library for creating
-scripts that fulfill your visualization needs.
+**ephyviewer** is both a standalone application and a Python library for
+creating scripts that fulfill your visualization needs.
 
-For an example of an application that utilizes ephyviewer's capabilities as a
-library, see the neurotic_ app and this paper:
+|screenshot|
+
+For an example of an application that utilizes **ephyviewer**'s capabilities as
+a library, see the neurotic_ app and this paper:
 
     Gill, J. P., Garcia, S., Ting, L. H., Wu, M., & Chiel, H. J. (2020).
     *neurotic*: Neuroscience Tool for Interactive Characterization. eNeuro,
     7(3). https://doi.org/10.1523/ENEURO.0085-20.2020
 
+.. _toc:
+
 Table of Contents
 -----------------
 
@@ -28,4 +38,34 @@ Table of Contents
     releasenotes
 
 
-.. _neurotic: https://github.com/jpgill86/neurotic
+.. |pypi-badge| image:: https://img.shields.io/pypi/v/ephyviewer.svg?logo=python&logoColor=white
+    :target: pypi_
+    :alt: PyPI
+
+.. |anaconda-cloud-badge| image:: https://img.shields.io/conda/vn/conda-forge/ephyviewer.svg?label=anaconda&logo=anaconda&logoColor=white
+    :target: anaconda-cloud_
+    :alt: Anaconda Cloud
+
+.. |github-badge| image:: https://img.shields.io/badge/github-source_code-blue.svg?logo=github&logoColor=white
+    :target: github_
+    :alt: GitHub
+
+.. |conda-forge-feedstock-badge| image:: https://img.shields.io/badge/conda--forge-feedstock-blue.svg?logo=conda-forge&logoColor=white
+    :target: conda-forge-feedstock_
+    :alt: conda-forge Feedstock
+
+.. |rtd-status-badge| image:: https://img.shields.io/readthedocs/ephyviewer/latest.svg?logo=read-the-docs&logoColor=white
+    :target: rtd-status_
+    :alt: Documentation Status
+
+.. |screenshot| image:: img/mixed_viewer_example.png
+    :alt: Screeshot
+
+.. _anaconda-cloud:         https://anaconda.org/conda-forge/ephyviewer
+.. _conda-forge-feedstock:  https://github.com/conda-forge/ephyviewer-feedstock
+.. _github:                 https://github.com/NeuralEnsemble/ephyviewer
+.. _other versions:         https://readthedocs.org/projects/ephyviewer/versions/
+.. _pypi:                   https://pypi.org/project/ephyviewer
+.. _rtd-status:             https://readthedocs.org/projects/ephyviewer
+
+.. _neurotic:               https://neurotic.readthedocs.io/en/latest/

doc/overview.rst

@@ -3,12 +3,12 @@
 Overview
 ========
 
-ephyviewer is a Python library for building custom viewers for
+**ephyviewer** is a Python library for building custom viewers for
 electrophysiological signals, video, events, epochs, spike trains, data tables,
-and time-frequency representations of signals. It also provides an epoch encoder
-for creating annotations.
+and time-frequency representations of signals. It also provides an epoch
+encoder for creating annotations.
 
-ephyviewer can be used as a standalone application (requires Neo_ ≥ 0.6) by
+**ephyviewer** can be used as a standalone application (requires Neo_ ≥ 0.6) by
 launching it from the console, then using the menu to open a data file::
 
     ephyviewer
@@ -21,8 +21,8 @@ optionally the format, though this can usually be detected automatically)::
     ephyviewer File_axon_1.abf
     ephyviewer File_axon_1.abf -f Axon
 
-However, where ephyviewer really shines is as a library for designing custom
-viewers in simple Python scripts that meet your individual needs::
+However, where **ephyviewer** really shines is as a library for designing
+custom viewers in simple Python scripts that meet your individual needs::
 
     import ephyviewer
     import numpy as np