Skip to content

Commit

Permalink
DOC add deployment action + update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joaopfonseca committed Feb 16, 2024
1 parent f2e1245 commit d142d9c
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 5 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
jobs:
# Build job
build:
# <Not provided for brevity>
# At a minimum this job should upload artifacts using actions/upload-pages-artifact

# Deploy job
deploy:
name: Documentation
# Add a dependency to the build job
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.12
architecture: x64

- name: Install
run: |
# NOTE: pip, setuptools and wheel should be included with any python
# installation. It's being installed/upgraded here because the
# setup-python action is not including setuptools with Python 3.12
pip install --upgrade pip setuptools wheel
pip install .[docs]
- name: Build Docs
run: |
cd doc
make html
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,13 @@ Some functions require Matplotlib (>= 2.2.3) for plotting.

### User Installation

**NOTE: DO NOT USE THIS METHOD. IT IS NOT IMPLEMENTED YET**

The easiest way to install ml-research is using ``pip`` :

pip install -U sharp
pip install -U xai-sharp

Or ``conda`` :

conda install -c conda-forge sharp
conda install -c conda-forge xai-sharp

The documentation includes more detailed [installation
instructions](https://sharp.readthedocs.io/en/latest/getting-started.html).
Expand All @@ -37,7 +35,7 @@ The following commands should allow you to setup the development version of the
project with minimal effort:

# Clone the project.
git clone https://github.com/joaopfonseca/sharp.git
git clone https://github.com/DataResponsibly/sharp.git
cd sharp

# Create and activate an environment
Expand Down

0 comments on commit d142d9c

Please sign in to comment.