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

Macros for documentation #2216

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

Macros for documentation #2216

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
aaba162
Rename to rst.pp
albinahlback Jan 29, 2025
a9b42d7
Add .rst files to gitignore
albinahlback Jan 29, 2025
dd4ef79
Fix Makefile for rst files
albinahlback Jan 29, 2025
4d4d41b
Add macros.m4
albinahlback Jan 29, 2025
31acb8c
Push inclusion of macros into every rst file
albinahlback Jan 29, 2025
d9c39c1
Include macros.m4 instead of config.m4
albinahlback Jan 29, 2025
7797759
Start on macros
albinahlback Jan 29, 2025
c30c54b
Add sphinx-specific options to not catch everything
albinahlback Jan 29, 2025
81457f0
More macros
albinahlback Jan 29, 2025
7e1769f
Start converting to macros
albinahlback Jan 29, 2025
7c6c442
Ensure that M4 is installed on documentation CI
albinahlback Jan 29, 2025
e45bc32
push preprocessed stuff into build directory
albinahlback Jan 30, 2025
06aadc4
Revert back to regular rst files
albinahlback Jan 30, 2025
64704bd
macros.m4 into files again
albinahlback Jan 30, 2025
5262d9d
Streamline m4 for documentation
albinahlback Jan 30, 2025
20cded8
Blaaaa
albinahlback Jan 30, 2025
b9d692d
Bla
albinahlback Jan 30, 2025
5a0bcd2
Bla
albinahlback Jan 30, 2025
ee70673
Make
albinahlback Jan 30, 2025
7c42e9e
bla
albinahlback Jan 31, 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
Prev Previous commit
Next Next commit
Make
  • Loading branch information
@albinahlback
albinahlback committed Jan 30, 2025
commit ee706730c094ff5825d91aef726610d8d8754132
6 changes: 5 additions & 1 deletion doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ BUILDDIR = build

M4 := m4

SPHINX_ACTIONS := html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf latexpdfja text man texinfo info gettext changes xml pseudoxml linkcheck doctest coverage clean
SPHINX_ACTIONS := html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf latexpdfja text man texinfo info gettext changes xml pseudoxml linkcheck doctest coverage

CONFIG := macros.m4
SRCS := $(wildcard $(ORIGSRCDIR)/*.rst)
Expand All @@ -29,6 +29,10 @@ preprocess: $(OBJS)
$(SPHINX_ACTIONS): Makefile preprocess
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
rm -f $(OBJS)
rm -rf $(BUILDDIR)

print-%:
@echo "$*=$($*)"

Expand Down