Skip to content

Commit

Permalink
Add Read the Docs config file and README badge.
Browse files Browse the repository at this point in the history
  • Loading branch information
lapets committed Dec 19, 2021
1 parent a5ea2b4 commit 2f55290
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Required
version: 2

sphinx:
configuration: docs/conf.py

formats:
- pdf

python:
version: "3.7"
install:
- requirements: docs/requirements.txt
- method: setuptools
path: .
7 changes: 6 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,23 @@ circuitry

Embedded domain-specific combinator library for assembling abstract definitions of logic circuits.

|pypi| |actions| |coveralls|
|pypi| |readthedocs| |actions| |coveralls|

.. |pypi| image:: https://badge.fury.io/py/circuitry.svg
:target: https://badge.fury.io/py/circuitry
:alt: PyPI version and link.

.. |readthedocs| image:: https://readthedocs.org/projects/circuitry/badge/?version=latest
:target: https://circuitry.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.

.. |actions| image:: https://github.com/nthparty/circuitry/workflows/lint-test-cover-docs/badge.svg
:target: https://github.com/nthparty/circuitry/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.

.. |coveralls| image:: https://coveralls.io/repos/github/nthparty/circuitry/badge.svg?branch=main
:target: https://coveralls.io/github/nthparty/circuitry?branch=main
:alt: Coveralls test coverage summary.

Purpose
-------
Expand Down

0 comments on commit 2f55290

Please sign in to comment.