Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

removes old readme link #5

Merged
merged 5 commits into from
Nov 19, 2024
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
59 changes: 59 additions & 0 deletions .github/workflows/build-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: build-github-pages
env:
GITHUB_ACTOR: domonik
GITHUB_REPOSITORY: domonik/RNAdist

on:
push:
tags:
- "v*.*.*"



# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
pages: write
id-token: write

jobs:
build_docs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ github.event.workflow_run.head_branch }}

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.10


- name: create environment with mamba
uses: conda-incubator/setup-miniconda@v2
with:
channels: conda-forge,defaults
auto-activate-base: false
activate-environment: rnadist_doc
environment-file: docs/environment.yml

- name: Render Rmd files
run: |
eval "$(conda shell.bash hook)"
conda activate rnadist_doc
cd docs
make html
cd ..

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Upload entire repository
path: 'docs/build/html'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
name: "testPackage"

on:
pull_request:
Expand Down Expand Up @@ -33,10 +34,14 @@ jobs:

- name: Install package
run: |
eval "$(conda shell.bash hook)"
conda activate RNAdistEnv
pip install ./ --no-deps --no-build-isolation
pip install pytest

- name: test package
run: |
eval "$(conda shell.bash hook)"
conda activate RNAdistEnv
rm RNAdist/ -r # Needs to be removed since it will try to test uncompiled package instead
pytest --pyargs RNAdist
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
RNAdist is a package to approximate expected distances on RNA
structures.

## [Getting Started](https://rnadist.readthedocs.io/en/stable/index.html)
## [Getting Started](https://domonik.github.io/RAPDOR/)

For installation details, documentation and various tutorials please have a look at our documentation page on
[ReadtheDocs](https://rnadist.readthedocs.io/en/stable/index.html)
For installation details, documentation and various tutorials please have a look at our documentation page here:

https://domonik.github.io/RAPDOR/

1 change: 1 addition & 0 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ dependencies:
- viennarna
- biopython
- pandas
- networkx
- plotly
- dash >=2.5
- dash-bootstrap-components
Expand Down
Loading