RYDE-WORK/ballistica
1
0
Fork 0
mirror of https://github.com/RYDE-WORK/ballistica.git synced 2026-01-31 03:39:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

modified: .gitignore

Browse Source 
modified:   src/assets/sphinx/template/conf.py
	modified:   tools/batools/docs.py
This commit is contained in:
Loup-Garou911XD 2024-03-07 11:40:43 +05:30
parent 2e65fc1770
commit 6a39f050dc
3 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -30,7 +30,7 @@ local.properties
PUBSYNC_IN_PROGRESS
_fulltest_buildfile_*
ballistica_files/
src/assets/sphinx/apidoc
src/assets/sphinx/.modules
**/.#*
# Environment files

3
src/assets/sphinx/template/conf.py
View File

@ -12,8 +12,7 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath(os.getenv('BALLISTICA_ROOT')+'/src/assets/ba_data/python/'))
sys.path.insert(0, os.path.abspath(os.getenv('BALLISTICA_ROOT')+'/tools/efro/'))
sys.path.insert(0, os.path.abspath(os.getenv('BALLISTICA_ROOT')+'/src/assets/sphinx/.modules/'))
# -- Options for HTML output -------------------------------------------------

23
tools/batools/docs.py
View File

@ -224,15 +224,25 @@ def _run_sphinx() -> None:
from batools.version import get_current_version
version, buildnum = get_current_version()
assets_dirs : dict = {'ba_data':'src/assets/ba_data/python/',
'dummy_modules':'build/dummymodules/',
'efro_package':'tools/efro/',
'bacommon_package':'tools/bacommon/'}
sphinx_src = 'src/assets/sphinx/'
build_dir = 'build/docs_sphinx_html'
sphinx_apidoc_out = sphinx_src + 'apidoc/'
template_dir = Path(sphinx_src+'template/')
assets_dir = 'src/assets/ba_data/python/'
dummy_modules_dir = 'build/dummymodules/'
os.makedirs(build_dir, exist_ok=True)
template_dir = Path(sphinx_src+'template/')
temp_modules_dir = sphinx_src + '.modules/'
sphinx_apidoc_out = temp_modules_dir + 'apidoc/'
os.makedirs(sphinx_apidoc_out, exist_ok=True)
assert template_dir.is_dir()
os.makedirs(temp_modules_dir, exist_ok=True)
shutil.copytree(assets_dirs['ba_data'], temp_modules_dir, dirs_exist_ok=True)
shutil.copytree(assets_dirs['dummy_modules'], temp_modules_dir, dirs_exist_ok=True)
shutil.copytree(assets_dirs['efro_package'], temp_modules_dir + 'efro/', dirs_exist_ok=True)
shutil.copytree(assets_dirs['bacommon_package'], temp_modules_dir + 'bacommon/', dirs_exist_ok=True)
shutil.copytree(template_dir, sphinx_apidoc_out, dirs_exist_ok= True)
@ -248,11 +258,12 @@ def _run_sphinx() -> None:
'-R', str(buildnum), # release
# '--templatedir', template_dir,
'-o', sphinx_apidoc_out,
assets_dir, ],
# dummy_modules_dir], # dummy modules doesn't get included like this
temp_modules_dir, ],
check=True)
subprocess.run( ['make', 'html'], check = True, cwd= sphinx_apidoc_out)
shutil.copytree(sphinx_apidoc_out + '_build/html/', build_dir, dirs_exist_ok=True)
shutil.rmtree(temp_modules_dir)
duration = time.monotonic() - starttime
print(f'Generated sphinx documentation in {duration:.1f}s.')