Skip to content

Commit 77f498d

Browse files
committed
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.
1 parent 998b774 commit 77f498d

File tree

9 files changed

+6454
-0
lines changed

9 files changed

+6454
-0
lines changed

docs/Makefile

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
SPHINXOPTS =
2+
SPHINXBUILD = sphinx-build
3+
SPHINXAUTOBUILD = sphinx-autobuild
4+
SPHINXPROJ = Leapp repository
5+
SOURCEDIR = source
6+
BUILDDIR = build
7+
8+
all: clean html
9+
10+
help:
11+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
12+
livehtml:
13+
@$(SPHINXAUTOBUILD) --watch ../repos --watch ../commands "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(0)
14+
15+
# Catch-all target: route all unknown targets to Sphinx using the new
16+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
17+
%: Makefile
18+
echo $@
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
20+
21+
.PHONY: all help Makefile

docs/requirements-docs.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
sphinx==7.2.6
2+
sphinx_rtd_theme
3+
sphinxcontrib-jquery
4+
docutils
5+
CommonMark
6+
myst-parser
7+
sphinx-autobuild

0 commit comments

Comments
 (0)