Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
.venv/
docs/build/
docs/build/

# MAKEFILE INTERMEDIATE FILES
docs/source/opkg/source_files/*.tar.gz
35 changes: 27 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,48 @@
.DEFAULT_GOAL := all

# DIRECTORIES
srcdir := src
# /DIRECTORIES
srcdir = docs/source


# BINARIES
export MAKE ?= make
export PYTHON ?= python3
export SPHINXBUILD = $(PYTHON) -m sphinx
# /BINARIES
export TAR ?= tar

export SPHINXOPTS ?= --fail-on-warning --keep-going


# ==============================================================================
# REAL TARGETS
# ==============================================================================

opkg_intro_dist = $(srcdir)/opkg/source_files/opkg-intro.tar.gz
$(opkg_intro_dist) : $(shell find $(srcdir)/opkg/source_files/opkg-intro/ -type f)
$(TAR) -czf $@ -C $(@D) opkg-intro/


dkms_opkg_dist = $(srcdir)/opkg/source_files/dkms-opkg.tar.gz
$(dkms_opkg_dist) : $(shell find $(srcdir)/opkg/source_files/dkms-opkg/ -type f)
$(TAR) -czf $@ -C $(@D) dkms-opkg/


# REAL TARGETS #
################
OBJ = \
$(opkg_intro_dist) \
$(dkms_opkg_dist)


# PHONY TARGETS #
#################
# ==============================================================================
# PHONY TARGETS
# ==============================================================================

all :
all : $(OBJ)
$(MAKE) -C docs html
.PHONY : all


clean :
rm -rf $(OBJ)
$(MAKE) -C docs clean
.PHONY : clean

Expand Down
6 changes: 6 additions & 0 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
div.body p,
div.body dd,
div.body li,
div.body blockquote {
hyphens: manual;
}
7 changes: 6 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,14 @@
#
html_theme = 'bizstyle'

html_css_files = [
"custom.css",
]

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
html_static_path = ["_static"]

html_context = {
'github_repo_url': 'https://github.com/ni/nilrt-docs/',
Expand All @@ -75,6 +79,7 @@

linkcheck_ignore = [
r"https://linux.die.net/.*", # linux.die.next denies robots with 403
r"https://git\.yoctoproject\.org/opkg-utils/?", # Cloudflare challenge causes unstable 403s in linkcheck
]

linkcheck_anchors_ignore_for_url = [
Expand Down
516 changes: 171 additions & 345 deletions docs/source/opkg/dkms_opkg.rst

Large diffs are not rendered by default.

Loading
Loading