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

Initial documentation refactor #878

Merged
merged 16 commits into from
Feb 14, 2025
Merged

Initial documentation refactor #878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
8a46fa9
docs: Use sphinx.ext.autosectionlabel instead of a local copy
matejmatuska Aug 6, 2024
db61951
docs: Move tutorials to separate dir
matejmatuska Jul 29, 2024
c87d58b
docs: Merge terminology and architecture into one section
matejmatuska Jul 29, 2024
d710e65
docs: Infrastructure - remove section about leapp-repository
matejmatuska Jul 29, 2024
3f71e84
docs: Rename Infrastructure to Packaging and dependencies
matejmatuska Jul 29, 2024
abce95a
docs: Packaging and deps - don't directly reference leapp-repo
matejmatuska Jul 29, 2024
3e018c6
docs: Move deprecations list and process to libraries-and-api
matejmatuska Jul 30, 2024
3d9eba0
docs: Move coding guidelines to contributing.md
matejmatuska Jul 30, 2024
833636c
docs: Move installation instructions to the top level
matejmatuska Jul 30, 2024
89ba260
docs: Remove leapp-repository related documents
matejmatuska Jul 29, 2024
54cc47c
docs: Fix non-consecutive and incorrect header levels
matejmatuska Jul 30, 2024
0127e4a
docs: Add make rule to prepare venv similar to RTD build env
matejmatuska Sep 10, 2024
945325e
docs: Add small snactor logo to the nav header
matejmatuska Feb 12, 2025
6b31975
docs: Polish building-blocks-and-architecture doc
matejmatuska Feb 13, 2025
728b5bf
docs: Update contact in contributing doc
matejmatuska Feb 13, 2025
e5ebbe0
doc: add notes to the main page
pirat89 Feb 14, 2025
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
22 changes: 18 additions & 4 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,27 @@ BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@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, so you do not need to think about it

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

# Prepare virtualenv similar to the environment used during build on Read The Docs and install required packages
env:
# ad. pip install -r doesn't really work with relative paths :), so keeping it in the project root
@PY_VER=$$(sed -n -e 's/^\s*python:\s"\(.*\)"/\1/p' ../.readthedocs.yaml); \
echo $$PY_VER; \
rm -fr ./venv; \
virtualenv venv --python=python$$PY_VER && \
source venv/bin/activate && \
pushd .. && pip install -r requirements-docs.txt; popd

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

.PHONY: all help Makefile
.PHONY: all help Makefile env
Loading