Restructures documentation reference section

This section was getting unwieldly. It is now less overwhelming. This change does a few things: 1. breaks things out into explicit files 2. changes the sphinx build to be htmlDir to get rid of pesky .html in the URL 3. removes some to be organized docs 4. fixes up a few typos 5. fixes links to match new structure
DAGWorks-Inc · Jul 5, 2023 · 02bea1c · 02bea1c
1 parent e55cb4d
commit 02bea1c
Show file tree

Hide file tree

Showing 72 changed files with 853 additions and 1,249 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,6 +13,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
+  builder: dirhtml
   fail_on_warning: true
   configuration: docs/conf.py
 

diff --git a/README-DOCS.md b/README-DOCS.md
@@ -11,12 +11,12 @@ pip install -r requirements-docs.txt
 ```
 and then one of the following to build and view the documents:
 ```bash
-sphinx-build -a docs /tmp/mydocs
+sphinx-build -b dirhtml -a docs /tmp/mydocs
 python -m http.server --directory /tmp/mydocs
 ```
 or for auto rebuilding do:
 ```bash
-sphinx-autobuild -W -E -T  --watch hamilton/ -a docs /tmp/mydocs
+sphinx-autobuild -b dirhtml -W -E -T  --watch hamilton/ -a docs /tmp/mydocs
 ```
 Then it'll be running on port 8000.
 

diff --git a/docs/best-practices/code-organization.rst b/docs/best-practices/code-organization.rst
diff --git a/docs/best-practices/common-indices.rst b/docs/best-practices/common-indices.rst
diff --git a/docs/best-practices/function-modifiers.rst b/docs/best-practices/function-modifiers.rst
diff --git a/docs/best-practices/function-naming.rst b/docs/best-practices/function-naming.rst
diff --git a/docs/best-practices/index.rst b/docs/best-practices/index.rst