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

docs: Initial docs structure and infrastructure #1272

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

docs: Initial docs structure and infrastructure #1272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4de4322
docs: Initial docs structure and infrastructure
matejmatuska Aug 1, 2024
cc1b09f
fixup! docs: Initial docs structure and infrastructure
matejmatuska Aug 1, 2024
4a1b5df
docs: Add make rule to prepare venv similar to RTD build environment
matejmatuska Sep 10, 2024
0f8b1c4
SQUASH ME Add dummy content
matejmatuska Sep 11, 2024
192470f
fixup! docs: Add make rule to prepare venv similar to RTD build envir…
matejmatuska Sep 11, 2024
0cf4cd5
[WIP] - add dracut modules and upgrade initramfs doc
matejmatuska Oct 1, 2024
c0493e2
docs(contrib): add coding and commit guidelines
Sep 11, 2024
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
3 changes: 2 additions & 1 deletion .github/workflows/codespell.yml
View file
Open in desktop
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"
31 changes: 31 additions & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXAUTOBUILD = sphinx-autobuild
SPHINXPROJ = Leapp repository
SOURCEDIR = source
BUILDDIR = build

all: clean html

help:
@source venv/bin/activate && \
$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
livehtml:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
livehtml:
livehtml: html

this will automatically build html without the need to think about it

@source venv/bin/activate && \
$(SPHINXAUTOBUILD) --watch ../repos --watch ../commands "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(0)

# Prepare virtualenv similar to the environment used during build on Read The Docs and install required packages
env:
@PY_VER=$$(sed -n -e 's/^\s*python:\s"\(.*\)"/\1/p' ../.readthedocs.yaml); \
rm -fr ./venv; \
virtualenv venv --python=python$$PY_VER && \
source venv/bin/activate && \
pip install -r requirements-docs.txt;

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@source venv/bin/activate && \
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: all help Makefile env
7 changes: 7 additions & 0 deletions docs/requirements-docs.txt
View file
Open in desktop
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
Loading