pylib/pydocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Structure change to reduce warnings

Browse Source
This commit is contained in:
Dirk Alders 2025-08-17 09:28:44 +02:00
parent aa518babde
commit 6b849a3732
2 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
sphinx.mk
View File

@ -3,10 +3,10 @@
SHELL = /usr/bin/bash SHELL = /usr/bin/bash
.SILENT: .SILENT:
SPHINXOPTS =
SPHINXBUILD = venv/bin/sphinx-build SPHINXBUILD = venv/bin/sphinx-build
SPHINXAPIDOC = venv/bin/sphinx-apidoc
SPHINXPRJ = $(shell basename `dirname \`pwd\``) SPHINXPRJ = $(shell basename `dirname \`pwd\``)
SOURCEDIR = . SOURCEDIR = pylibs
BUILDDIR = _build BUILDDIR = _build
localhelp: localhelp:
@ -28,29 +28,28 @@ conf.py: pydocs/templates/conf.py.tpl
pydocs/replace.sh conf.py "<year>" "$$(date +%Y)" pydocs/replace.sh conf.py "<year>" "$$(date +%Y)"
pydocs/replace.sh conf.py "<author>" "Dirk Alders" pydocs/replace.sh conf.py "<author>" "Dirk Alders"
index.rst: $(SOURCEDIR)/$(SPHINXPRJ).rst:
venv/bin/sphinx-apidoc -TMo . $(SPHINXPRJ) $(SPHINXAPIDOC) -TMo $(SOURCEDIR) $(SOURCEDIR)/$(SPHINXPRJ)
mv $(SPHINXPRJ).rst index.rst
html: head examples conf.py index.rst html: head examples conf.py $(SOURCEDIR)/$(SPHINXPRJ).rst
echo -e "\e[1m * Generated html files...\e[0m" echo -e "\e[1m * Generated html files...\e[0m"
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) $(SPHINXBUILD) --conf-dir . "$(SOURCEDIR)" "$(BUILDDIR)"
examples: examples:
make -C $(SPHINXPRJ)/_examples_ all make -C pylibs/$(SPHINXPRJ)/_examples_ all
localclean: localclean:
echo -e "\033[1;33mCleanung up docs...\033[00m" echo -e "\033[1;33mCleanung up docs...\033[00m"
echo -e "\e[1m * Sphix config files...\e[0m" echo -e "\e[1m * Sphix config files...\e[0m"
rm -vf conf.py *.rst rm -vf conf.py pylibs/*.rst
echo -e "\e[1m * Sphix build directory...\e[0m" echo -e "\e[1m * Sphix build directory...\e[0m"
rm -rf $(BUILDDIR) rm -rf $(BUILDDIR)
make --no-print-directory -kC $(SPHINXPRJ)/_examples_ clean make --no-print-directory -kC pylibs/$(SPHINXPRJ)/_examples_ clean
release: html release: html
rm -rf $(SPHINXPRJ)/_docs_ rm -rf $(SPHINXPRJ)/_docs_
mv $(BUILDDIR)/html $(SPHINXPRJ)/_docs_ mv $(BUILDDIR)/html $(SPHINXPRJ)/_docs_
view: html view: html
xdg-open $(BUILDDIR)/html/index.html xdg-open $(BUILDDIR)/$(SPHINXPRJ).html

4
templates/conf.py.tpl
View File

@ -14,7 +14,7 @@
# #
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('pylibs'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
@ -54,7 +54,7 @@ templates_path = ['_templates']
source_suffix = '.rst' source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = '<module_name>'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.