From 8b16c25363445c0556dd3906968296afbaeb1aac Mon Sep 17 00:00:00 2001 From: Sally Makin Date: Wed, 7 Jun 2023 10:14:31 +0100 Subject: [PATCH] Add README.md and rename folder --- {docs => doc}/.sphinx/requirements.txt | 0 {docs => doc}/Makefile | 0 doc/README.md | 8 ++++++++ {docs => doc}/_static/css/custom.css | 0 {docs => doc}/_static/css/github_issue_links.css | 0 {docs => doc}/_static/css/logo.css | 0 {docs => doc}/_static/js/github_issue_links.js | 0 {docs => doc}/_static/ubuntu_logo.png | Bin {docs => doc}/conf.py | 0 {docs => doc}/development/index.rst | 0 {docs => doc}/explanation/index.rst | 0 {docs => doc}/howto/index.rst | 0 {docs => doc}/index.rst | 0 {docs => doc}/reference/index.rst | 0 {docs => doc}/tutorial/index.rst | 0 15 files changed, 8 insertions(+) rename {docs => doc}/.sphinx/requirements.txt (100%) rename {docs => doc}/Makefile (100%) create mode 100644 doc/README.md rename {docs => doc}/_static/css/custom.css (100%) rename {docs => doc}/_static/css/github_issue_links.css (100%) rename {docs => doc}/_static/css/logo.css (100%) rename {docs => doc}/_static/js/github_issue_links.js (100%) rename {docs => doc}/_static/ubuntu_logo.png (100%) rename {docs => doc}/conf.py (100%) rename {docs => doc}/development/index.rst (100%) rename {docs => doc}/explanation/index.rst (100%) rename {docs => doc}/howto/index.rst (100%) rename {docs => doc}/index.rst (100%) rename {docs => doc}/reference/index.rst (100%) rename {docs => doc}/tutorial/index.rst (100%) diff --git a/docs/.sphinx/requirements.txt b/doc/.sphinx/requirements.txt similarity index 100% rename from docs/.sphinx/requirements.txt rename to doc/.sphinx/requirements.txt diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..57bf8fac --- /dev/null +++ b/doc/README.md @@ -0,0 +1,8 @@ +# Documentation + +This temporary folder (`../doc/`) is subject to change and only exists to help +migrate the official documentation for this project to readthedocs.com. + +The `../documentation/` folder is the working location for our docs. Any changes +you would like to add to the documentation should be made from this directory, +and not from `../doc/`. diff --git a/docs/_static/css/custom.css b/doc/_static/css/custom.css similarity index 100% rename from docs/_static/css/custom.css rename to doc/_static/css/custom.css diff --git a/docs/_static/css/github_issue_links.css b/doc/_static/css/github_issue_links.css similarity index 100% rename from docs/_static/css/github_issue_links.css rename to doc/_static/css/github_issue_links.css diff --git a/docs/_static/css/logo.css b/doc/_static/css/logo.css similarity index 100% rename from docs/_static/css/logo.css rename to doc/_static/css/logo.css diff --git a/docs/_static/js/github_issue_links.js b/doc/_static/js/github_issue_links.js similarity index 100% rename from docs/_static/js/github_issue_links.js rename to doc/_static/js/github_issue_links.js diff --git a/docs/_static/ubuntu_logo.png b/doc/_static/ubuntu_logo.png similarity index 100% rename from docs/_static/ubuntu_logo.png rename to doc/_static/ubuntu_logo.png diff --git a/docs/conf.py b/doc/conf.py similarity index 100% rename from docs/conf.py rename to doc/conf.py diff --git a/docs/development/index.rst b/doc/development/index.rst similarity index 100% rename from docs/development/index.rst rename to doc/development/index.rst diff --git a/docs/explanation/index.rst b/doc/explanation/index.rst similarity index 100% rename from docs/explanation/index.rst rename to doc/explanation/index.rst diff --git a/docs/howto/index.rst b/doc/howto/index.rst similarity index 100% rename from docs/howto/index.rst rename to doc/howto/index.rst diff --git a/docs/index.rst b/doc/index.rst similarity index 100% rename from docs/index.rst rename to doc/index.rst diff --git a/docs/reference/index.rst b/doc/reference/index.rst similarity index 100% rename from docs/reference/index.rst rename to doc/reference/index.rst diff --git a/docs/tutorial/index.rst b/doc/tutorial/index.rst similarity index 100% rename from docs/tutorial/index.rst rename to doc/tutorial/index.rst