jan/meanas
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improve doc generation and fix code links

Browse Source
This commit is contained in:
jan 2021-07-05 14:58:39 -07:00
parent 8faefff98d
commit 23490694ff
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
make_docs.sh
View File

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

2
pdoc_templates/config.mako
View File

@ -20,7 +20,7 @@
#git_link_template = 'https://bitbucket.org/USER/PROJECT/src/{commit}/{path}#lines-{start_line}:{end_line}' #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 = 'https://CGIT_HOSTNAME/PROJECT/tree/{path}?id={commit}#n{start_line}'
#git_link_template = None #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. # A prefix to use for every HTML hyperlink in the generated documentation.
# No prefix results in all links being relative. # No prefix results in all links being relative.