docs: add docs for RTD

tmihoc · Dec 4, 2024 · 9ed174a · 9ed174a
1 parent e07983e
commit 9ed174a
Show file tree

Hide file tree

Showing 208 changed files with 121 additions and 11,132 deletions.
diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt
@@ -1,3 +1,3 @@
-canonical-sphinx[full] @ git+https://github.com/canonical/canonical-sphinx@main
+canonical-sphinx[full]
 sphinx-autobuild
-sphinxcontrib-svg2pdfconverter[CairoSVG]
+sphinx-tabs
diff --git a/docs/conf.py b/docs/conf.py
@@ -27,7 +27,7 @@
 #
 # TODO: Update with the official name of your project or product
 
-project = "Juju CLI and core"
+project = "Juju"
 author = "Canonical Ltd."
 
 
@@ -201,9 +201,9 @@
 #       - youtube-links
 
 extensions = [
-    "canonical_sphinx",
-    "sphinxcontrib.cairosvgconverter",
-]
+    'canonical_sphinx',
+    'sphinx_design',
+    ]
 
 
 # Excludes files or directories from processing

diff --git a/docs/custom_conf.py b/docs/custom_conf.py
@@ -2,7 +2,7 @@
 import subprocess
 import shutil
 
-cli_dir = "user/cli/"
+cli_dir = "user/reference/cli/"
 
 # Remove existing cli folder to regenerate it
 if os.path.exists(cli_dir):
@@ -30,7 +30,7 @@
 
 # Add the template for the index file containing the command list.
 if (not os.path.isfile(cli_dir + 'index.md')):
-    os.system('cp ' + 'user/cli_index.template ' + cli_dir + 'index.md')
+    os.system('cp ' + 'user/reference/cli_index.template ' + cli_dir + 'index.md')
 
 # Write the list of commands to the index file toctree.
 with open(cli_dir + "index.md", 'a') as index:

diff --git a/docs/dev/how-to/create-new-mongo-db-collection.md b/docs/dev/how-to/create-new-mongo-db-collection.md
diff --git a/docs/dev/how-to/create-unit-test-suite.md b/docs/dev/how-to/create-unit-test-suite.md