diff --git a/docs/autodoc.md b/docs/autodoc.md new file mode 100644 index 0000000..1e71a4f --- /dev/null +++ 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` \ No newline at end of file diff --git a/docs/ci.md b/docs/ci.md new file mode 100644 index 0000000..1e71a4f --- /dev/null +++ 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` \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 1c152e2..20b9db7 100644 --- 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 ==================