diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..1adbb5a --- /dev/null +++ b/.readthedocs.yaml @@ -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.11" diff --git a/README.rst b/README.rst index 002fbff..e5e86bc 100644 --- a/README.rst +++ b/README.rst @@ -4,12 +4,16 @@ permutations Python library for instantiating and working with permutation collections that provide efficient implementations of all sequence methods (including random-access retrieval by index). -|pypi| |actions| |coveralls| +|pypi| |readthedocs| |actions| |coveralls| .. |pypi| image:: https://badge.fury.io/py/permutations.svg :target: https://badge.fury.io/py/permutations :alt: PyPI version and link. +.. |readthedocs| image:: https://readthedocs.org/projects/permutations/badge/?version=latest + :target: https://permutations.readthedocs.io/en/latest/?badge=latest + :alt: Read the Docs documentation status. + .. |actions| image:: https://github.com/lapets/permutations/workflows/lint-test-cover-docs/badge.svg :target: https://github.com/lapets/permutations/actions/workflows/lint-test-cover-docs.yml :alt: GitHub Actions status. @@ -130,7 +134,7 @@ This library can be published as a `package on PyPI `__ that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ``?.?.?`` with the version number): .. code-block:: bash diff --git a/pyproject.toml b/pyproject.toml index 24e35f3..3ab1771 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,6 +16,7 @@ requires-python = ">=3.7" [project.urls] Repository = "https://github.com/lapets/permutations" +Documentation = "https://permutations.readthedocs.io" [project.optional-dependencies] docs = [