fix: add comments

ApeWorX · Aug 5, 2024 · 9c34d3a · 9c34d3a
1 parent ed804a9
commit 9c34d3a
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -66,4 +66,4 @@ jobs:
           with:
               branch: gh-pages
               directory: gh-pages
-              github_token: ${{ secrets.GITHUB_TOKEN }}
+              github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -63,6 +63,7 @@ Then, open your browser to `127.0.0.1:1337` and click the `ape` directory link.
 
 ```{note}
 Serving from `"docs/_build/"` rather than `"docs/_build/ape"` is necessary to make routing work.
+```
 
 ## Pull Requests
 

diff --git a/setup.py b/setup.py
@@ -29,7 +29,7 @@
         "sphinx_rtd_theme>=1.2.0,<2",  # Readthedocs.org theme
         "sphinxcontrib-napoleon>=0.7",  # Allow Google-style documentation
         "sphinx-plausible>=0.1.2,<0.2",  # For analytics
-        "shibuya",
+        "shibuya",  # Documentation website theme
     ],
     "release": [  # `release` GitHub Action job uses this
         "setuptools",  # Installation tool
-Original file line number
+Diff line change
@@ Expand Up @@
     ```{note}
     Serving from `"docs/_build/"` rather than `"docs/_build/ape"` is necessary to make routing work.
+    ```
     ## Pull Requests
@@ Expand Down @@