Commit c813f0e4 authored by User expired's avatar User expired
Browse files

doc: Convert documentation to reStructuredText

parent 541260f0
......@@ -26,10 +26,8 @@ doc: README.html doc/bibtools.pdf
clean:
$(if $(wildcard $(CLEAN)),$(RM) $(wildcard $(CLEAN)))
md_to_rst_to_html = pandoc -t rst $< | rst2html -t $(STYLE) - $@
%.html : %.md
$(if $(shell which pandoc),$(if $(shell which rst2html),$(md_to_rst_to_html),\
$(if $(shell which rst2html),rst2html -t $(STYLE) $< $@,\
$(info Please install 'python-docutils' to create html documentation.)))
doc/bibtools.pdf: doc/bibtools.tex $(wildcard doc/figures/*.jpg)
......
=======================================
Command line tools for bibtex citations
=======================================
......@@ -9,43 +10,39 @@ Command line tools for bibtex citations
- Extract single records
- Output text citations for copy and paste
The html version of this file is created with `pandoc` and `python-docutils`:
The html version of this file is created with ``python-docutils``::
make README.html
Author
: Bjoern Bastian
Date
:Author: Bjoern Bastian
: 2019-08-06
:Date: 2019-09-09
Usage
-----
=====
See online documentation in
[bibtools.pdf](https://bbastian.pavo.uberspace.de/files/bibtools/bibtools.pdf)
or build `doc/bibtools.pdf` yourself with `make doc`.
or build ``doc/bibtools.pdf`` yourself with ``make doc``.
Setup
-----
GNU AWK is required. For Ubuntu you may install the `gawk` package:
=====
GNU AWK is required. For Ubuntu you may install the ``gawk`` package::
sudo apt-get install gawk
Install scripts to `$HOME/bin`:
Install scripts to ``$HOME/bin``::
make install
Run all or selected tests:
Run all or selected tests::
make test # all tests
./test/test_runner pattern...
With one or more filter patterns containing the wildcard `*`. Otherwise,
usual regular expressions are supported, for example `testJournal[UD]*`.
With one or more filter patterns containing the wildcard ``*``. Otherwise,
usual regular expressions are supported, for example ``testJournal[UD]*``.
Remove scripts from `$HOME/bin`:
Remove scripts from ``$HOME/bin``::
make uninstall
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment