Skip to content

Commit

Permalink
Add a docs RTD file, add some badges
Browse files Browse the repository at this point in the history
  • Loading branch information
Myoldmopar committed Jul 30, 2024
1 parent 5d15345 commit 5307def
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
7 changes: 3 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ build:
sphinx:
configuration: docs/conf.py

# Optional but recommended, declare the Python requirements required
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
python:
install:
- requirements: docs/requirements.txt
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@ This is a collection of solar angle and related calculations.
## Source
These are based mostly on Chapter 6 of _Heating, Ventilation, and Air Conditioning_ by Faye McQuistion and Jerald Parker, 3rd Edition, 1988, with minor pieces from other versions of the same book. Other sources are noted in the source. All the functions were written from scratch by me.

## Releases [![PyPIRelease](https://github.com/Myoldmopar/SolarCalculations/actions/workflows/release.yml/badge.svg)](https://github.com/Myoldmopar/SolarCalculations/actions/workflows/release.yml) ![PyPI - Version](https://img.shields.io/pypi/v/solar-angles)
The latest release can be found on the [Releases](https://github.com/Myoldmopar/SolarCalculations/releases/latest) page. All packages are distributed through [PyPi](https://pypi.org/project/solar-angles/).

## Documentation [![](https://readthedocs.org/projects/solar-calculations/badge/?version=latest)](http://solar-calculations.readthedocs.org/en/latest/)
Documentation is hosted on [ReadTheDocs](http://solar-calculations.readthedocs.org/en/latest/). The functions are all documented with Markdown syntax doc strings in a way that Sphinx can interpret them. To build the documentation, enter the docs/ subdirectory and execute `make html`; then open `/docs/_build/html/index.html` to see the documentation.

## Testing [![](https://travis-ci.org/Myoldmopar/SolarCalculations.svg?branch=master)](https://travis-ci.org/Myoldmopar/SolarCalculations)
## Testing
The source is tested using the python unittest framework. To execute all the unit tests, just execute the test file (since it calls `unittest.main()`): `python test/test_solar.py`. The tests are also executed by [Travis CI](https://travis-ci.org/Myoldmopar/SolarCalculations).

## Validation
Expand Down
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
sphinx
sphinx-rtd-theme
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ flake8

# for documentation
sphinx
sphinx-rtd-theme

# for packaging
wheel
Expand Down

0 comments on commit 5307def

Please sign in to comment.