Move code-related pages under new code directory

Namely, `plugins.rst` becomes `code/plugins.rst`, which vacates a place for documentation of actual plugins to live in `plugins/`.
teemtee · Jan 2, 2024 · 49b9ddb · 49b9ddb
1 parent 91fe542
commit 49b9ddb
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 # tmt-specific
 
 /tmp/
-docs/autodocs/*.rst
+docs/code/autodocs/*.rst
 docs/_build
 docs/spec
 docs/stories

diff --git a/docs/Makefile b/docs/Makefile
@@ -19,7 +19,7 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 .PHONY: help generate-stories generate-autodocs clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
 
 clean:
-	rm -rf $(BUILDDIR) stories spec autodocs/*.rst
+	rm -rf $(BUILDDIR) stories spec docs/autodocs/*.rst
 
 ##
 ## Building documentation
@@ -74,7 +74,7 @@ generate-stories: stories  ## Generate documentation sources for stories
 generate-test-checks: spec spec/test-checks.rst  ## Generate documentation sources for test checks
 
 generate-autodocs:  ## Generate autodocs from source docstrings
-	cd ../ && sphinx-apidoc --force --implicit-namespaces --no-toc -o docs/autodocs tmt
+	cd ../ && sphinx-apidoc --force --implicit-namespaces --no-toc -o docs/code/autodocs tmt
 
 ##
 ## Help!

diff --git a/docs/autodocs/.gitkeep → docs/code/autodocs/.gitkeep b/docs/autodocs/.gitkeep → docs/code/autodocs/.gitkeep
diff --git a/docs/classes.rst → docs/code/classes.rst b/docs/classes.rst → docs/code/classes.rst
diff --git a/docs/code.rst → docs/code/index.rst b/docs/code.rst → docs/code/index.rst
diff --git a/docs/plugins.rst → docs/code/plugins.rst b/docs/plugins.rst → docs/code/plugins.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -33,5 +33,5 @@ Table of Contents
     Stories <stories>
     Questions <questions>
     Contribute <contribute>
-    Code <code>
+    Code <code/index>
     Releases <releases>