[Chore] Couple of small chores (#49)

* use working dir instead of cd

* urls

* add docs build to contributing

* upgrade gha step versions in lint

* remoce extra empty line in unit test

* use livehtml

Author: Jackmin801

.github/workflows/docs.yaml

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Setup Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
           architecture: x64
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Dependencies
         run: |
           set -eux
@@ -27,10 +27,10 @@ jobs:
 
           pip install -r docs/requirements.txt
       - name: Build Sphinx Docs
+        working-directory: docs
         run: |
           set -eux
 
-          cd docs
           make html
       - name: Upload static files as artifact
         id: deployment

.github/workflows/lint.yaml

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Setup Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
           architecture: x64
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Dependencies
         run: |
           set -eux

.github/workflows/unittest.yaml

@@ -40,4 +40,3 @@ jobs:
 
         pytest -v
         cargo test -v
-

CONTRIBUTING.md

@@ -85,6 +85,17 @@ To run the entire suite of tests:
 $ scripts/test.sh
 ```
 
+### Build Docs
+To build the docs run:
+```sh
+pip install -r docs/requirements.txt
+cd docs
+make livehtml
+```
+
+The docs will be built in the `docs/build/html` directory and served at http://localhost:8000.
+The page will be automatically re-built as long as the process is kept running.
+
 ## Contributor License Agreement ("CLA")
 
 In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of

docs/requirements.txt

@@ -6,3 +6,4 @@ papermill
 ipykernel
 ipython_genutils
 jinja2==3.1.4
+sphinx-autobuild

pyproject.toml

@@ -15,6 +15,11 @@ dependencies = [
     "torch"
 ]
 
+[project.urls]
+Documentation = "https://pytorch-labs.github.io/torchft"
+Repository = "https://github.com/pytorch-labs/torchft"
+Issues = "https://github.com/pytorch-labs/torchft/issues"
+
 [project.optional-dependencies]
 dev = [
     "pytest",