diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..5996770 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,41 @@ +name: Deploy Sphinx Docs + +on: + push: + branches: + - main # Change this to your default branch if it's not 'main' + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 # Ensure full history is fetched for Git actions + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.6' # Use your desired Python version + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install . + pip install sphinx sphinx_rtd_theme myst-parser nbsphinx + + - name: Build Sphinx documentation + run: | + cd docs + ./sync_notebooks.sh + ./autoapidoc.sh + make html + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/build/html + publish_branch: gh-pages diff --git a/README.md b/README.md index c1c543c..5e28820 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Partial Ranker -Partial Ranker is a library that implements methodologies for ranking a given set of objects with a *strict partial order* relation. For full documentations can be found here (TODO:Add link). +Partial Ranker is a library that implements methodologies for ranking a given set of objects with a *strict partial order* relation. Full documentations can be found here (TODO:Add link). **Input**: @@ -25,18 +25,18 @@ Rank 0: ['t0', 't1'], Rank 1: ['t2'] ``` -### Installation +## Installation Partial Ranker requires Python>=3.6 and can be installed using the command: ```bash pip install git+https://github.com/HPAC/PartialRanker ``` -### Examples +## Examples For usage and application examples, please follow the jupyter notebooks under the folder ``examples/``. -### Reference +## Reference More details on partial ranking, the methodologies and applications can be found in [this paper](https://arxiv.org/abs/2405.18259). If you are using this library, please cite: diff --git a/docs/source/requirements.txt b/docs/requirements.txt similarity index 100% rename from docs/source/requirements.txt rename to docs/requirements.txt