-
Notifications
You must be signed in to change notification settings - Fork 148
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Initial docs structure and infrastructure
NOTE: sphinx-autodoc is NOT included, because the way it works is by importing python modules, which are (apart from commands) not used in this repository, therefore it doesn't work.
- Loading branch information
1 parent
998b774
commit 77f498d
Showing
9 changed files
with
6,454 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
SPHINXOPTS = | ||
SPHINXBUILD = sphinx-build | ||
SPHINXAUTOBUILD = sphinx-autobuild | ||
SPHINXPROJ = Leapp repository | ||
SOURCEDIR = source | ||
BUILDDIR = build | ||
|
||
all: clean html | ||
|
||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
livehtml: | ||
@$(SPHINXAUTOBUILD) --watch ../repos --watch ../commands "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(0) | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: Makefile | ||
echo $@ | ||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: all help Makefile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
sphinx==7.2.6 | ||
sphinx_rtd_theme | ||
sphinxcontrib-jquery | ||
docutils | ||
CommonMark | ||
myst-parser | ||
sphinx-autobuild |
Oops, something went wrong.