Skip to content

Commit

Permalink
Add Read the Docs config and update README with badge/instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
lapets committed Jan 6, 2025
1 parent 552b5ad commit d993048
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
19 changes: 19 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
version: 2

sphinx:
configuration: docs/conf.py

formats:
- pdf

python:
install:
- method: pip
path: .
extra_requirements:
- docs

build:
os: 'ubuntu-22.04'
tools:
python: '3.12'
10 changes: 9 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ nilql

Library for working with encrypted data within nilDB queries and replies.

|actions|
|readthedocs| |actions|

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

.. |actions| image:: https://github.com/nillionnetwork/nilql-py/workflows/lint-test-cover-docs/badge.svg#
:target: https://github.com/nillionnetwork/nilql-py/actions/workflows/lint-test-cover-docs.yml
Expand Down Expand Up @@ -66,3 +70,7 @@ In order to contribute to the source code, open an issue or submit a pull reques
Versioning
^^^^^^^^^^
The version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`__.

Publishing
^^^^^^^^^^
Ensure that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions.

0 comments on commit d993048

Please sign in to comment.