Skip to content

Commit

Permalink
fix(docs): Improve the look of the docs index page
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey authored and Chris Mackey committed Oct 28, 2020
1 parent 0a40b33 commit 9aa796d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@
[![Build Status](https://travis-ci.org/ladybug-tools/honeybee-radiance-folder.svg?branch=master)](https://travis-ci.org/ladybug-tools/honeybee-radiance-folder)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-radiance-folder/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-radiance-folder)

[![Python
2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/)
[![Python
3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
[![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/)
[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
[![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

Honeybee Radiance folder is a python library to read, write and validate
Honeybee Radiance Folder is a Python library to read, write and validate the
[Radiance folder structure](https://github.com/ladybug-tools/radiance-folder-structure).

# Installation

`pip install -U honeybee-radiance-folder`

# [API Documentation](https://www.ladybug.tools/honeybee-radiance-folder/docs/)

# Usage

Expand Down
18 changes: 13 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
.. Honeybee Radiance Folder documentation master file, created by
sphinx-quickstart on Wed Mar 13 20:09:41 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Honeybee Radiance Folder's documentation!
====================================================

.. image:: http://www.ladybug.tools/assets/img/honeybee.png

Honeybee Radiance Folder is a Python library to read, write and validate the
`Radiance folder structure <https://github.com/ladybug-tools/radiance-folder-structure>`_.

Installation
============

`pip install -U honeybee-radiance-folder`

Documentation
=============

.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down

0 comments on commit 9aa796d

Please sign in to comment.