Skip to content

Commit

Permalink
Fix docs (#7)
Browse files Browse the repository at this point in the history
* add sphinx deps for building docs, fixed doc deploy
* fixed docs links, added badges
  • Loading branch information
k-dominik committed Nov 17, 2023
1 parent a405cf4 commit a625cc2
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
[![test](https://github.com/ilastik/ilastikrag/actions/workflows/test.yaml/badge.svg)](https://github.com/ilastik/ilastikrag/actions/workflows/test.yaml)
[![test](https://github.com/ilastik/ilastikrag/actions/workflows/test.yml/badge.svg)](https://github.com/ilastik/ilastikrag/actions/workflows/test.yml)
[![conda version on ilastik-forge](https://anaconda.org/ilastik-forge/ilastikrag/badges/version.svg)](https://anaconda.org/ilastik-forge/ilastikrag)
[![platforms on ilastik-forge](https://anaconda.org/ilastik-forge/ilastikrag/badges/platforms.svg)](https://anaconda.org/ilastik-forge/ilastikrag)
[![downloads on ilastik-forge](
https://anaconda.org/ilastik-forge/ilastikrag/badges/downloads.svg)](https://anaconda.org/ilastik-forge/ilastikrag)

ilastikrag
==========
Expand All @@ -16,5 +20,5 @@ Installation
conda install -c ilastik-forge ilastikrag
```

[Documentation]: http://stuarteberg.github.io/ilastikrag
[Quickstart Tutorial]: http://stuarteberg.github.io/ilastikrag/_static/quickstart-tutorial.html
[Documentation]: https://ilastik.github.io/ilastikrag/
[Quickstart Tutorial]: https://ilastik.github.io/ilastikrag/_static/quickstart-tutorial.html
3 changes: 3 additions & 0 deletions dev/environment-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,6 @@ dependencies:
- python>=3.7
- setuptools_scm
- vigra
# for building the docs
- sphinx
- sphinx_rtd_theme
4 changes: 1 addition & 3 deletions docs/push-to-origin-gh-pages.sh
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ curr_commit=$(git rev-parse HEAD)

# Read the url of the user's 'origin' remote
origin_details=$(git remote -v | grep "^origin\s")
origin_url=$(echo ${origin_details} | python -c "import sys; print sys.stdin.read().split(' ')[1]")
origin_url=$(echo ${origin_details} | python -c "import sys; print(sys.stdin.read().split(' ')[1])")

# Clone a copy into /tmp/
rm -rf /tmp/ilastikrag-gh-pages
Expand All @@ -41,8 +41,6 @@ cp -r "${repo_dir}"/docs/build/html/* .
# but we don't need jekyll anyway. Disable it.
touch .nojekyll

# Copy circle.yml so that circle-ci knows not to build this branch.
cp -r ${repo_dir}/circle.yml .

# Commit everything to gh-pages
git add .
Expand Down

0 comments on commit a625cc2

Please sign in to comment.