Sitelet https://github.com/math-comp/math-comp/issues/1396
Skip to content

Improving Tips in README.md #1396

Description

@hoheinzollern

Currently the tips section in the readme is a bit unclear about the htmldoc generation, suggestion welcome for how to improve it. Especially looking at the Makefile I'm not able to understand precisely what the import-doc target does:

import-doc:
	-git subtree add -P htmldoc release/$(R)
	T=`git subtree split -P htmldoc release/$(R)`;\
	git subtree merge -P htmldoc --squash $$T \
		-m 'importing htmldoc from $(R)'

It would be also helpful to batch-generate org to html, so I suggest adding the following to the Makefile:

ORG_FILES=$(wildcard *.org)
HTML_FILES=$(ORG_FILES:.org=.html)

all: 

org-html: $(HTML_FILES)

%.html: %.org
	emacs --batch $< -e org-html-export-to-html

the all: target is meant to suppress defaulting to import-doc, as it sounds to me that this could have unintended consequences if one runs it by mistake.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions