Skip to content

Commit f4ddb1f

Browse files
authored
docs: Updated docs for 0.1.0 release (#42)
* docs: Added logo to documentation * docs: Updated readme with logo * docs: Updated readme Added pypi badge
1 parent b7c1ee7 commit f4ddb1f

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
1-
# PyroNear
2-
[![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)
1+
![PyroNear Logo](docs/source/_static/img/pyronear-logo-dark.png)
2+
3+
<p align="center">
4+
<a href="LICENSE" alt="License">
5+
<img src="https://img.shields.io/badge/License-MIT-brightgreen.svg" /></a>
6+
<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">
7+
<img src="https://api.codacy.com/project/badge/Grade/55423de221b14b18a5e35804574d5d5a"/></a>
8+
<a href="https://circleci.com/gh/frgfm/PyroNear">
9+
<img src="https://circleci.com/gh/frgfm/PyroNear.svg?style=shield" /></a>
10+
<a href="https://codecov.io/gh/frgfm/PyroNear">
11+
<img src="https://codecov.io/gh/frgfm/PyroNear/branch/master/graph/badge.svg" /></a>
12+
<a href="https://frgfm.github.io/PyroNear">
13+
<img src="https://img.shields.io/badge/docs-available-blue.svg" /></a>
14+
<a href="https://pypi.org/project/pyronear/" alt="Pypi">
15+
<img src="https://img.shields.io/badge/pypi-v0.1.0-blue.svg" /></a>
16+
</p>
17+
18+
19+
20+
# PyroNear: early wildfire detection
321

422
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.
523

12.5 KB
Loading

docs/source/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,11 @@
7676
html_theme_options = {
7777
'collapse_navigation': False,
7878
'display_version': True,
79-
'logo_only': False,
79+
'logo_only': True,
8080
}
8181

82+
html_logo = '_static/img/pyronear-logo-dark.png'
83+
8284
# Add any paths that contain custom static files (such as style sheets) here,
8385
# relative to this directory. They are copied after the builtin static files,
8486
# so a file named "default.css" will overwrite the builtin "default.css".

0 commit comments

Comments
 (0)