Add Documentation to the autotools pipeline

This commit is contained in:
2022-03-14 15:33:10 +01:00
parent 69611ec0d8
commit 4d8be00774
9 changed files with 77 additions and 53 deletions

View File

@@ -1,36 +0,0 @@
# variables
#
SPHINX_BUILD_DIR = build
DOXYGEN_INDEX = $(SPHINX_BUILD_DIR)/doxygen/html/index.html
EXTRA_STYLESHEET_URL = https://github.com/jothepro/doxygen-awesome-css.git
DX_HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css
# rules
#
all: doxygen sphinx
.PHONY: sphinx doxygen
doxygen: $(DOXYGEN_INDEX)
$(DX_HTML_EXTRA_STYLESHEET):
git clone $(EXTRA_STYLESHEET_URL)
$(DOXYGEN_INDEX): Doxyfile $(DX_HTML_EXTRA_STYLESHEET)
mkdir -p $(@D)
doxygen $<
$(SPHINX_BUILD_DIR)/index.html: index.rst atrip.rst conf.py
sphinx-build . $(SPHINX_BUILD_DIR)
sphinx: $(SPHINX_BUILD_DIR)/index.html
index.rst: ../README.rst
cp $< $@
atrip.rst: ../atrip.rst
cp $< $@
../%.rst:
make -C $(dir $@) $(notdir $@)
clean:
rm -rfv sphinx doxygen/ index.rst atrip.rst

38
docs/Makefile.am Normal file
View File

@@ -0,0 +1,38 @@
include $(top_srcdir)/etc/make/emacs.mk
# variables
#
SPHINX_BUILD_DIR = build
DOXYGEN_INDEX = $(SPHINX_BUILD_DIR)/doxygen/html/index.html
DX_EXTRA_STYLESHEET_URL = https://github.com/jothepro/doxygen-awesome-css.git
DX_HTML_EXTRA_FOLDER = $(builddir)/doxygen-awesome-css
DX_HTML_EXTRA_STYLESHEET = $(DX_HTML_EXTRA_FOLDER)/doxygen-awesome.css
all: doxygen sphinx
.PHONY: sphinx doxygen
doxygen: $(DOXYGEN_INDEX)
$(DOXYGEN_INDEX): Doxyfile $(DX_HTML_EXTRA_STYLESHEET)
mkdir -p $(@D)
doxygen $<
$(DX_HTML_EXTRA_STYLESHEET):
git clone $(DX_EXTRA_STYLESHEET_URL) $(DX_HTML_EXTRA_FOLDER)
$(SPHINX_BUILD_DIR)/index.html: index.rst atrip.rst conf.py
sphinx-build -b html . $(SPHINX_BUILD_DIR)
sphinx: $(SPHINX_BUILD_DIR)/index.html
index.rst: $(top_srcdir)/README.rst
cp $< $@
atrip.rst: $(top_srcdir)/atrip.rst
cp $< $@
clean-local:
rm -rfv sphinx doxygen/ index.rst atrip.rst \
$(SPHINX_BUILD_DIR) \
$(DX_HTML_EXTRA_FOLDER)

View File

@@ -5,7 +5,7 @@ extensions = [ 'breathe' ]
templates_path = ['_templates']
exclude_patterns = []
html_theme = 'nature'
html_static_path = ['_static']
#html_static_path = ['_static']
breathe_projects = { "atrip": "doxygen/xml/" }
breathe_default_project = "atrip"

View File

@@ -12,6 +12,7 @@ pkgs.mkShell rec {
python3Packages.breathe
doxygen
sphinx
git
graphviz
];