Skip to content

Commit

Permalink
docs: Updated docs for 0.1.0 release (#42)
Browse files Browse the repository at this point in the history
* docs: Added logo to documentation

* docs: Updated readme with logo

* docs: Updated readme

Added pypi badge
  • Loading branch information
frgfm authored Oct 28, 2019
1 parent b7c1ee7 commit f4ddb1f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# PyroNear
[![Donate](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/55423de221b14b18a5e35804574d5d5a)](https://www.codacy.com/manual/fg/pyronear?utm_source=github.com&utm_medium=referral&utm_content=frgfm/PyroNear&utm_campaign=Badge_Grade)[![CircleCI](https://circleci.com/gh/frgfm/PyroNear.svg?style=shield)](https://circleci.com/gh/frgfm/PyroNear) [![codecov](https://codecov.io/gh/frgfm/PyroNear/branch/master/graph/badge.svg)](https://codecov.io/gh/frgfm/PyroNear) [![Docs](https://img.shields.io/badge/docs-available-blue.svg)](https://frgfm.github.io/PyroNear)
![PyroNear Logo](docs/source/_static/img/pyronear-logo-dark.png)

<p align="center">
<a href="LICENSE" alt="License">
<img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" /></a>
<a href="https://www.codacy.com/manual/fg/pyronear?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=frgfm/PyroNear&amp;utm_campaign=Badge_Grade">
<img src="https://api.codacy.com/project/badge/Grade/55423de221b14b18a5e35804574d5d5a"/></a>
<a href="https://circleci.com/gh/frgfm/PyroNear">
<img src="https://circleci.com/gh/frgfm/PyroNear.svg?style=shield" /></a>
<a href="https://codecov.io/gh/frgfm/PyroNear">
<img src="https://codecov.io/gh/frgfm/PyroNear/branch/master/graph/badge.svg" /></a>
<a href="https://frgfm.github.io/PyroNear">
<img src="https://img.shields.io/badge/docs-available-blue.svg" /></a>
<a href="https://pypi.org/project/pyronear/" alt="Pypi">
<img src="https://img.shields.io/badge/pypi-v0.1.0-blue.svg" /></a>
</p>



# PyroNear: early wildfire detection

The increasing adoption of mobile phones have significantly shortened the time required for firefighting agents to be alerted of a starting wildfire. In less dense areas, limiting and minimizing this duration remains critical to preserve forest areas.

Expand Down
Binary file added docs/source/_static/img/pyronear-logo-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,11 @@
html_theme_options = {
'collapse_navigation': False,
'display_version': True,
'logo_only': False,
'logo_only': True,
}

html_logo = '_static/img/pyronear-logo-dark.png'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down

0 comments on commit f4ddb1f

Please sign in to comment.