Skip to content

Commit 891c82a

Browse files
aarmeyclaude
andcommitted
Move docs hosting from Read the Docs to GitHub Pages
.readthedocs.yml pointed at docs/requirements.txt, which was deleted in #1009, and used the deprecated top-level python.version config format, so RTD builds were failing outright. Rather than fix the RTD config, build and deploy the Sphinx docs via GitHub Actions to GitHub Pages (which the repo already had pages configured for), and drop the stale codecov and readthedocs badges from the README. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent 8f08909 commit 891c82a

6 files changed

Lines changed: 46 additions & 17 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [master]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v7
22+
- name: Setup submodule
23+
run: git submodule update --init --recursive
24+
- name: Install uv
25+
uses: astral-sh/setup-uv@v10.0.1
26+
with:
27+
enable-cache: true
28+
- name: Install dependencies
29+
run: uv sync --extra docs
30+
- name: Build docs
31+
run: uv run sphinx-build -b html docs docs/_build/html
32+
- uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: docs/_build/html
35+
36+
deploy:
37+
needs: build
38+
runs-on: ubuntu-latest
39+
environment:
40+
name: github-pages
41+
url: ${{ steps.deployment.outputs.page_url }}
42+
steps:
43+
- id: deployment
44+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,5 @@ spell.txt
2323
.vscode
2424
lineage/data/taxol
2525
output/
26+
docs/_build/
2627

‎.readthedocs.yml‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎README.rst‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22
tHMM
33
====
44

5-
.. image:: https://codecov.io/gh/meyer-lab/tHMM/branch/master/graph/badge.svg
6-
:target: https://codecov.io/gh/meyer-lab/tHMM
7-
8-
.. image:: https://readthedocs.org/projects/tHMM/badge/?version=latest
9-
:target: https://lineage-growth.readthedocs.io/
10-
11-
125
``tHMM`` is a Python3 package for clustering, visualizing, and analyzing data in the form of lineage trees. This work is now published in Communications Biology https://www.nature.com/articles/s42003-022-04208-9
136

147

@@ -41,7 +34,7 @@ Install the environment and dependencies by running:
4134
Documentation
4235
-------------
4336

44-
Please find the documentation at https://thmm.readthedocs.io.
37+
Please find the documentation at https://meyer-lab.github.io/tHMM/.
4538

4639
License
4740
-------

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/_config.yml‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)