Browse Source

improve doc generation and fix code links

master
jan 3 months ago
parent
commit
23490694ff
  1. 10
      make_docs.sh
  2. 2
      pdoc_templates/config.mako

10
make_docs.sh

@ -1,4 +1,7 @@
#!/bin/bash
set -Eeuo pipefail
cd ~/projects/meanas
# Approach 1: pdf to html?
@ -6,9 +9,10 @@ cd ~/projects/meanas
# pandoc --metadata=title:"meanas" --toc --toc-depth=4 --from=markdown+abbreviations --to=html --output=doc.html --gladtex -s -
# Approach 2: pdf to html with gladtex
pdoc3 --pdf --force --template-dir pdoc_templates -o doc . > doc.md
pandoc --metadata=title:"meanas" --from=markdown+abbreviations --to=html --output=doc.html --gladtex -s --css pdoc_templates/pdoc.css doc.md
gladtex -a -n -d _doc_mathimg -c white doc.html
rm -r _doc_mathimg
pdoc --pdf --force --template-dir pdoc_templates -o doc . > doc.md
pandoc --metadata=title:"meanas" --from=markdown+abbreviations --to=html --output=doc.htex --gladtex -s --css pdoc_templates/pdoc.css doc.md
gladtex -a -n -d _doc_mathimg -c white doc.htex
# Approach 3: html with gladtex
#pdoc3 --html --force --template-dir pdoc_templates -o doc .

2
pdoc_templates/config.mako

@ -20,7 +20,7 @@
#git_link_template = 'https://bitbucket.org/USER/PROJECT/src/{commit}/{path}#lines-{start_line}:{end_line}'
#git_link_template = 'https://CGIT_HOSTNAME/PROJECT/tree/{path}?id={commit}#n{start_line}'
#git_link_template = None
git_link_template = 'https://mpxd.net/code/jan/fdfd_tools/src/commit/{commit}/{path}#L{start_line}-L{end_line}'
git_link_template = 'https://mpxd.net/code/jan/meanas/src/commit/{commit}/{path}#L{start_line}-L{end_line}'
# A prefix to use for every HTML hyperlink in the generated documentation.
# No prefix results in all links being relative.

Loading…
Cancel
Save