Better comments for docs (#31)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
C-Loftus · Mar 5, 2024 · 531b16f · 531b16f
1 parent 76ed09d
commit 531b16f
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git a/requirements-docs.txt → .github/requirements-docs.txt b/requirements-docs.txt → .github/requirements-docs.txt
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,10 +31,10 @@ jobs:
           python-version: "3.10"
           cache: "pip"
           cache-dependency-path: |
-            requirements-docs.txt
+            .github/requirements-docs.txt
 
       - name: Install dependencies
-        run: pip install -r requirements-docs.txt
+        run: pip install -r .github/requirements-docs.txt
 
       - name: Build docs
         run: |

diff --git a/conf.py b/conf.py
@@ -8,7 +8,7 @@
 
 project = "Talon-AI-Tools"
 copyright = "2024 Colton Loftus"
-author = "Colton Loftus, Joshua Aretsy, Pokey Rule, and Others"
+author = "Colton Loftus, Joshua Aretsy, Pokey Rule, and others from the Talon Community"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -31,6 +31,7 @@
     # Enables definition lists
     # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
     "deflist",
+    "substitution",
 ]
 
 # -- Options for TalonDoc ----------------------------------------------------
@@ -46,3 +47,6 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
+
+
+myst_substitutions = {"author": author}
diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,8 @@
 # Documentation for talon-ai-tools
 
-This is a placeholder.
+This is a placeholder. Documentation is automatically generated using talondoc and Github Actions.
 
-To generate the documentation, run:
+To generate the documentation locally, run:
 
 ```sh
 python -X utf8 -m talondoc autogen -o docs --generate-index

diff --git a/index.md b/index.md
@@ -1,3 +1,5 @@
+<!-- This document is used for generating the docs, with this index.md being the docs root -->
+
 # Talon-AI-Tools Documentation
 
 :::{toctree}
@@ -15,3 +17,7 @@ Use large language models and AI tools alongside Talon. Currently supports:
 - OpenAI API for image generation and vision
 
 These tools are helpful to automatically generate text, fix errors in dictation, and generally speed up your Talon workflow.
+
+## Authors
+
+This repository contains code from {{author}}