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

[docs] Update docs #129

Merged
merged 8 commits into from
Jan 31, 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
4 changes: 3 additions & 1 deletion .github/workflows/sphinx_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# SPDX-License-Identifier: Apache-2.0

name: "Build documentation"
# This workflow is triggered on pushes to the repository.
on:
push:
branches:
Expand Down Expand Up @@ -36,6 +35,7 @@ jobs:
# cd /root/llvm-project
# git apply llvm_patch
- name: Build HCL-MLIR
shell: bash
run: |
source activate hcl-dev
export SUBMOD_COMMIT=$(git rev-parse HEAD:externals/hcl_mlir)
Expand All @@ -48,6 +48,7 @@ jobs:
cd tools/hcl/python_packages/hcl_core
python3 -m pip install -e .
- name: Build docs
shell: bash
run: |
source activate hcl-dev
export ALLO_HOME=$(pwd)
Expand Down Expand Up @@ -77,6 +78,7 @@ jobs:
- run: touch docs/build/html/.nojekyll
- name: Deploy docs to website
uses: cpina/github-action-push-to-another-repository@main
if: github.event_name == 'push'
env:
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
with:
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx==4.5.0
sphinx
sphinx-gallery
sphinx-copybutton
autodocsumm
Expand Down
7 changes: 4 additions & 3 deletions docs/source/setup/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ Installation
To install and use Allo, we need to have the LLVM compiler infrastructure installed on our system.
We have already prepared a prebuilt version of LLVM on our server, so you can directly export it to your system path.
Please follow the instruction below to set up the environment.
If you want to install Allo on your local machine, you can refer to the [README](https://github.com/cornell-zhang/allo) guideline in the Allo repository.

Make sure you have the access to the :code:`brg-zhang` or :code:`zhang-21` server. You can log into the server by
Make sure you have the access to the :code:`brg-zhang` or other Zhang group server. You can log into the server by
SSH or use VSCode Remote SSH extension. Please refer to `this website <https://code.visualstudio.com/docs/remote/ssh>`_
for more details on configuring VSCode. Those servers are only accessible from the campus network.

Expand All @@ -39,14 +40,14 @@ After the installation, you can create a new environment for Allo by running the

.. code-block:: console

$ conda create -n allo python=3.8
$ conda create -n allo python=3.12
$ conda activate allo

We also provide a script to set up the backend LLVM compiler. You can copy the script to your home directory and run it

.. code-block:: console

$ cp /work/shared/common/allo/setup.sh ~/
$ cp /work/shared/common/allo/setup-py312.sh ~/
$ source ~/setup.sh

.. note::
Expand Down
Loading