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
26 changes: 13 additions & 13 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@
version: 2

build:
image: latest
os: ubuntu-22.04
# Pre-build job: Run update_docs.py to regenerate API docs and convert READMEs
# This runs before Sphinx builds the documentation
commands:
- python docs/update_docs.py --skip-build
os: "ubuntu-22.04"
tools:
python: "3.9"
jobs:
pre_build:
# Pre-build job: Run update_docs.py to regenerate API docs and convert READMEs
# This runs before Sphinx builds the documentation
- python docs/update_docs.py --skip-build

python:
version: 3.9
install:
- requirements: requirements.txt
- requirements: docs/requirements-docs.txt
# Install our python package before building the docs
- method: pip
path: .
- method: pip
# Install documentation dependencies
pip_install:
- sphinx
- pypandoc

# Sphinx will be auto-detected from docs/docs/source/conf.py
sphinx:
configuration: docs/docs/source/conf.py
10 changes: 5 additions & 5 deletions docs/docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
OrthoEvolution
====================

.. image:: https://travis-ci.org/datasnakes/OrthoEvolution.svg?branch=master
:target: https://travis-ci.org/datasnakes/OrthoEvolution
.. image:: https://github.com/datasnakes/OrthoEvolution/actions/workflows/ci.yml/badge.svg
:target: https://github.com/datasnakes/OrthoEvolution/actions/workflows/ci.yml

.. image:: https://api.codacy.com/project/badge/Grade/25062944794a4d14b5cab274a885ac27
:target: https://www.codacy.com/app/datasnakes/OrthoEvolution?utm_source=github.com&utm_medium=referral&utm_content=datasnakes/OrthoEvolution&utm_campaign=Badge_Grade

.. image:: https://img.shields.io/badge/chat-on%20gitter-753A88.svg
:target: https://gitter.im/datasnakes/OrthoEvolution

.. image:: https://badge.fury.io/py/OrthoEvol.svg
:target: https://badge.fury.io/py/OrthoEvol

.. image:: https://codecov.io/gh/datasnakes/OrthoEvolution/branch/main/graph/badge.svg
:target: https://codecov.io/gh/datasnakes/OrthoEvolution

.. image:: https://readthedocs.org/projects/orthoevolution/badge/?version=latest
:target: http://orthoevolution.readthedocs.io/en/latest/?badge=latest

Expand Down
3 changes: 3 additions & 0 deletions docs/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Documentation build dependencies for Read the Docs
sphinx
pypandoc