Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ This project adheres to the `Open Code of Conduct <https://github.com/spotify/co
Contributing
------------

`See the contributing docs <CONTRIBUTING.rst>`_.
`See the contributing docs <https://github.com/spotify/chartify/blob/master/CONTRIBUTING.rst>`_.
8 changes: 4 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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