Skip to content
Snippets Groups Projects

Auto-build docs from markdown files

Merged Duncan Macleod requested to merge duncanmmacleod/bayeswave:docs into master
10 files
+ 129
4
Compare changes
  • Side-by-side
  • Inline
Files
10
doc/build.sh 0 → 100644
+ 21
0
#!/bin/bash
cd "$(dirname $(readlink -f "${BASH_SOURCE[0]}"))"
# convert README to index.rst for sphinx
pandoc --from=gfm --to=rst --output=index.rst ../README.md
# add a toctree to link the other markdown files
cat >> index.rst << EOF
.. toctree::
:hidden:
install
quickstart
running
examples
EOF
# run sphinx
python3 -m sphinx -M html . _build
Loading