docs: add manual docs on autodoc/ci

alex-ong · Dec 29, 2023 · 528f492 · 528f492
1 parent dfcf9a3
commit 528f492
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 0 deletions.
diff --git a/docs/autodoc.md b/docs/autodoc.md
@@ -0,0 +1,24 @@
+Automatic documentation
+===
+
+The documentation in this repo was setup using this guide:
+https://redandgreen.co.uk/sphinx-to-github-pages-via-github-actions/
+
+
+Key commands
+===
+
+Setup from scratch: 
+
+`cd /docs`
+`sphinx-quickstart`
+
+Generate .rst's automatically (from root directory)
+`sphinx-apidoc -o docs .`
+
+Manually generate html (already done in Github Action):
+`cd docs && make html`
+
+Clean html
+
+`cd docs && make clean`
diff --git a/docs/ci.md b/docs/ci.md
@@ -0,0 +1,24 @@
+Automatic documentation
+===
+
+The documentation in this repo was setup using this guide:
+https://redandgreen.co.uk/sphinx-to-github-pages-via-github-actions/
+
+
+Key commands
+===
+
+Setup from scratch: 
+
+`cd /docs`
+`sphinx-quickstart`
+
+Generate .rst's automatically (from root directory)
+`sphinx-apidoc -o docs .`
+
+Manually generate html (already done in Github Action):
+`cd docs && make html`
+
+Clean html
+
+`cd docs && make clean`
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,10 @@ Welcome to adventofcode2023's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   autodoc.md
+   ci.md
    modules
+
 
 Indices and tables
 ==================