Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move code-related pages under new code directory #2545

Merged
merged 1 commit into from
Jan 4, 2024
Merged

Move code-related pages under new code directory #2545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# tmt-specific

/tmp/
docs/autodocs/*.rst
docs/code/autodocs/*.rst
docs/_build
docs/spec
docs/stories
Expand Down
4 changes: 2 additions & 2 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 code/autodocs/*.rst

##
## Building documentation
Expand Down Expand Up @@ -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!
Expand Down
0 docs/autodocs/.gitkeep → docs/code/autodocs/.gitkeep
View file
Open in desktop
File renamed without changes.
0 docs/classes.rst → docs/code/classes.rst
View file
Open in desktop
File renamed without changes.
0 docs/code.rst → docs/code/index.rst
View file
Open in desktop
File renamed without changes.
0 docs/plugins.rst → docs/code/plugins.rst
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ Table of Contents
Stories <stories>
Questions <questions>
Contribute <contribute>
Code <code>
Code <code/index>
Releases <releases>
Loading