Skip to content

updating README.md and Makefile #109

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
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
15 changes: 8 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# this
ORG_FILES=$(wildcard *.org)
HTML_FILES=$(ORG_FILES:.org=.html)

R=1.6
# default target does nothing
all:

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)'
org-html: $(HTML_FILES)

%.html: %.org
emacs --batch $< -e org-html-export-to-html
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ Please push a git tag with every commit inserting a new reference,
so that watchers get notified.

## Tips

Html files pushed here are put online straight away.

Running `make` in the htmldoc directory updates the html files
generated by coqdoc and the library graph.
The steps to produce the updated documentation for `math-comp` are
reported on the [MathComp GitHub wiki](https://github.com/math-comp/math-comp/wiki/Howto-Release#steps)

Some html files are actually generated from eponymous org files
(extension `.org`). They are generated using emacs: open the
`blah.org` with emacs, press `C-c C-e h h` to generate the
corresponding `blah.html`. After editing the `.org` file, you
should perform this operation to generate the `.html` file. Both files
can then be committed and pushed on the main repository (just modifying
the `org` file and pushing has no effect on the displayed page).
corresponding `blah.html`. Alternatively, run the command `make org-html`
from the main folder. After editing the `.org` file, you
should perform this operation to generate the `.html` file. Both
files can then be committed and pushed on the main repository (just
modifying the `org` file and pushing has no effect on the displayed
page).