Skip to content

Commit

Permalink
Merge pull request #769 from StingraySoftware/use_readthedocs
Browse files Browse the repository at this point in the history
Use readthedocs
  • Loading branch information
matteobachetti committed Oct 10, 2023
2 parents 17fbaf0 + 734b09f commit d8c5ee7
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,30 @@
# 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.10"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# 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: docs/requirements.txt
1 change: 1 addition & 0 deletions docs/changes/769.trivial.rst
@@ -0,0 +1 @@
Use Readthedocs for documentation building
7 changes: 7 additions & 0 deletions docs/requirements.txt
@@ -0,0 +1,7 @@
jinja2<=3.0.0
docutils
sphinx-astropy
nbsphinx>=0.8.3,!=0.8.8
pandoc
ipython
towncrier<22.12.0

0 comments on commit d8c5ee7

Please sign in to comment.