From f564b1d3b14d7b63549e7911ef1c8397a139fff3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Milo=C5=A1=20Prchl=C3=ADk?= Date: Tue, 5 Dec 2023 11:32:42 +0100 Subject: [PATCH] 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/`. --- .gitignore | 2 +- docs/Makefile | 4 ++-- docs/{ => code}/autodocs/.gitkeep | 0 docs/{ => code}/classes.rst | 0 docs/{code.rst => code/index.rst} | 0 docs/{ => code}/plugins.rst | 0 docs/index.rst | 2 +- 7 files changed, 4 insertions(+), 4 deletions(-) rename docs/{ => code}/autodocs/.gitkeep (100%) rename docs/{ => code}/classes.rst (100%) rename docs/{code.rst => code/index.rst} (100%) rename docs/{ => code}/plugins.rst (100%) diff --git a/.gitignore b/.gitignore index 324729501c..e335335fe8 100644 --- 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 index 7cfcf61fd6..0358671cac 100644 --- 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 b/docs/code/autodocs/.gitkeep similarity index 100% rename from docs/autodocs/.gitkeep rename to docs/code/autodocs/.gitkeep diff --git a/docs/classes.rst b/docs/code/classes.rst similarity index 100% rename from docs/classes.rst rename to docs/code/classes.rst diff --git a/docs/code.rst b/docs/code/index.rst similarity index 100% rename from docs/code.rst rename to docs/code/index.rst diff --git a/docs/plugins.rst b/docs/code/plugins.rst similarity index 100% rename from docs/plugins.rst rename to docs/code/plugins.rst diff --git a/docs/index.rst b/docs/index.rst index f2646985e4..0b6db6b813 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,5 +33,5 @@ Table of Contents Stories Questions Contribute - Code + Code Releases