Skip to content

Commit

Permalink
Add Read the Docs integration and update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
lapets committed Aug 29, 2023
1 parent a32f6a4 commit ac8b0f5
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
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.11"
8 changes: 6 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -130,7 +134,7 @@ This library can be published as a `package on PyPI <https://pypi.org/project/pe
python -m pip install .[publish]
Ensure that the correct version number appears in ``pyproject.toml``. Create and push a tag for this version (replacing ``?.?.?`` with the version number):
Ensure that the correct version number appears in ``pyproject.toml``, and 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. Create and push a tag for this version (replacing ``?.?.?`` with the version number):

.. code-block:: bash
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down

0 comments on commit ac8b0f5

Please sign in to comment.