lots of readthedocs debugging
This commit is contained in:
parent
0574766a81
commit
317d106b9c
15
generate-docs.sh
Normal file → Executable file
15
generate-docs.sh
Normal file → Executable file
@ -1,8 +1,19 @@
|
||||
#!/usr/bin/env bash
|
||||
# super hacky script to generate documentation when developing and for readthedocs
|
||||
|
||||
source venv/bin/activate
|
||||
echo "Generating docs!"
|
||||
|
||||
pip install sphinx
|
||||
if command -v 'sphinx-apidoc' >/dev/null; then
|
||||
source venv/bin/activate
|
||||
pip install sphinx
|
||||
fi
|
||||
|
||||
if [[ $1 == 'generate' ]]; then
|
||||
|
||||
PYTHONPATH=../../ sphinx-apidoc -e -f -o . ../../riscemu ../../riscemu/colors.py ../../riscemu/__main__.py
|
||||
echo "only generating, not building..."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
PYTHONPATH=. sphinx-apidoc -e -f -o sphinx-docs/source riscemu riscemu/colors.py riscemu/__main__.py
|
||||
|
||||
|
@ -1,4 +1,7 @@
|
||||
import os, sys
|
||||
import os
|
||||
import sys
|
||||
import subprocess
|
||||
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
@ -15,6 +18,9 @@ import os, sys
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
if os.getenv('READTHEDOCS', False) and not os.path.exists('riscemu.rst'):
|
||||
subprocess.check_call(['../../generate-docs.sh', 'generate'])
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user