Skip to content

Commit 0816648

Browse files
kecnryJenneh
andauthored
add logos to docs (#48)
* add logos to docs and readme * add badges to readme --------- Co-authored-by: jenneh <[email protected]>
1 parent 4e33981 commit 0816648

File tree

7 files changed

+152
-8
lines changed

7 files changed

+152
-8
lines changed

README.rst

+19-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1-
LCviz
2-
=====
1+
.. image:: docs/logos/lcviz.svg
2+
:width: 400
3+
:alt: lcviz logo
4+
:align: center
5+
6+
.. image:: https://github.com/spacetelescope/lcviz/workflows/CI/badge.svg
7+
:target: https://github.com/spacetelescope/lcviz/actions
8+
:alt: GitHub Actions CI Status
9+
10+
.. image:: https://codecov.io/gh/spacetelescope/lcviz/branch/main/graph/badge.svg
11+
:target: https://codecov.io/gh/spacetelescope/lcviz
12+
13+
.. image:: https://readthedocs.org/projects/lcviz/badge/?version=latest
14+
:target: https://lcviz.readthedocs.io/en/latest/?badge=latest
15+
:alt: Documentation Status
316

417
.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
518
:target: http://www.astropy.org
@@ -9,6 +22,10 @@ LCviz
922
:target: https://github.com/spacetelescope/jdaviz/
1023
:alt: Powered by jdaviz Badge
1124

25+
.. image:: http://img.shields.io/badge/powered%20by-lightkurve-6570b1.svg?style=flat
26+
:target: https://github.com/lightkurve/lightkurve/
27+
:alt: Powered by lightkurve Badge
28+
1229

1330
Early Development Software Warning
1431
----------------------------------

docs/conf.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -186,10 +186,14 @@
186186
# A shorter title for the navigation bar. Default is the same as html_title.
187187
# html_short_title = None
188188

189+
# The name of an image file (relative to this directory) to place at the top
190+
# of the sidebar.
191+
html_logo = 'logos/lcviz.svg'
192+
189193
# The name of an image file (within the static path) to use as favicon of the
190194
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
191195
# pixels large.
192-
# html_favicon = None
196+
html_favicon = 'logos/lcviz.ico'
193197

194198
# Add any extra paths that contain custom files (such as robots.txt or
195199
# .htaccess) here, relative to this directory. These files are copied

docs/index.rst

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
*******************
2-
LCviz Documentation
3-
*******************
1+
.. |lcviz_logo| image:: ./logos/lcviz_icon.svg
2+
:height: 42px
3+
4+
5+
******************
6+
|lcviz_logo| lcviz
7+
******************
48

59
``lcviz`` is a light curve visualization and analysis tool within the Jupyter environment (lab or
610
notebook), built on top of `Jdaviz <https://jdaviz.readthedocs.io>`_ and `lightkurve <https://docs.lightkurve.org>`_::

docs/installation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22
.. _install:
33

4-
Install
5-
=======
4+
Installation
5+
============
66

77
.. note::
88

docs/logos/lcviz.ico

4.19 KB
Binary file not shown.

docs/logos/lcviz.svg

+65
Loading

docs/logos/lcviz_icon.svg

+54
Loading

0 commit comments

Comments
 (0)