Skip to content

Commit

Permalink
docs: Initial docs structure and infrastructure
Browse files Browse the repository at this point in the history
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
matejmatuska committed Aug 1, 2024
1 parent 998b774 commit b2bacdd
Show file tree
Hide file tree
Showing 10 changed files with 6,456 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,5 @@ jobs:
./etc/leapp/files/device_driver_deprecation_data.json,\
./etc/leapp/files/pes-events.json,\
./etc/leapp/files/repomap.json,\
./repos/system_upgrade/common/files/prod-certs"
./repos/system_upgrade/common/files/prod-certs,\
./docs/source/_static/"
21 changes: 21 additions & 0 deletions docs/Makefile
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
7 changes: 7 additions & 0 deletions docs/requirements-docs.txt
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
Loading

0 comments on commit b2bacdd

Please sign in to comment.