From cd7e9fabe20f42d0a76ada0e32b62c5a4e1f50dd Mon Sep 17 00:00:00 2001 From: lrjball Date: Wed, 2 Aug 2023 22:53:20 +0100 Subject: [PATCH 1/2] Added readthedocs config yaml file --- .readthedocs.yaml | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3a362c2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,43 @@ +# Read the Docs configuration file for Sphinx projects + +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + + +# Required + +version: 2 + + +# Set the OS, Python version and other tools you might need + +build: + + os: ubuntu-22.04 + + tools: + + python: "3.11" + + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - pdf + - epub + + +# Optional but recommended, declare the Python requirements required + +# to build your documentation + +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html + +python: + + install: + + - requirements: requirements_dev.txt \ No newline at end of file From 28d1369886ab2e9699098af7bc8908c0e32a484e Mon Sep 17 00:00:00 2001 From: lrjball Date: Wed, 2 Aug 2023 23:08:03 +0100 Subject: [PATCH 2/2] Updated broken paths in docs --- README.rst | 2 +- docs/installation.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index a172e06..1244fcb 100644 --- a/README.rst +++ b/README.rst @@ -77,4 +77,4 @@ This project adheres to the `Open Code of Conduct `_. +`See the contributing docs `_. diff --git a/docs/installation.rst b/docs/installation.rst index 1e9a10a..2d7c362 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -32,13 +32,13 @@ You can either clone the public repository: .. code-block:: console - $ git clone git://github.com/cphalpert/chartify + $ git clone git://github.com/spotify/chartify Or download the `tarball`_: .. code-block:: console - $ curl -OL https://github.com/cphalpert/chartify/tarball/master + $ curl -OL https://github.com/spotify/chartify/tarball/master Once you have a copy of the source, you can install it with: @@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with: $ python setup.py install -.. _Github repo: https://github.com/cphalpert/chartify -.. _tarball: https://github.com/cphalpert/chartify/tarball/master +.. _Github repo: https://github.com/spotify/chartify +.. _tarball: https://github.com/spotify/chartify/tarball/master