RYDE-WORK/ballistica
1
0
Fork 0
mirror of https://github.com/RYDE-WORK/ballistica.git synced 2026-02-05 15:03:33 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

modified: Makefile

Browse Source 
modified:   src/assets/sphinx/template/conf.py
	modified:   tools/batools/docs.py
This commit is contained in:
Loup-Garou911XD 2024-03-07 12:37:41 +05:30
parent 6a39f050dc
commit 77e3c21d77
3 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -185,7 +185,7 @@ docs-pdoc:
@$(PCOMMAND) gen_docs_pdoc @$(PCOMMAND) gen_docs_pdoc
docs-sphinx: docs-sphinx:
$(MAKE) dummymodules # $(MAKE) dummymodules
@$(PCOMMAND) gen_docs_sphinx @$(PCOMMAND) gen_docs_sphinx
pcommandbatch_speed_test: prereqs pcommandbatch_speed_test: prereqs

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

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

8
tools/batools/docs.py
View File

@ -213,7 +213,7 @@ def _run_pdoc() -> None:
duration = time.monotonic() - starttime duration = time.monotonic() - starttime
print(f'{Clr.GRN}Generated pdoc documentation in {duration:.1f}s.{Clr.RST}') print(f'{Clr.GRN}Generated pdoc documentation in {duration:.1f}s.{Clr.RST}')
def generate_sphinxdoc(): def generate_sphinxdoc() -> None:
_run_sphinx() _run_sphinx()
def _run_sphinx() -> None: def _run_sphinx() -> None:
@ -245,9 +245,7 @@ def _run_sphinx() -> None:
shutil.copytree(assets_dirs['bacommon_package'], temp_modules_dir + 'bacommon/', 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) shutil.copytree(template_dir, sphinx_apidoc_out, dirs_exist_ok= True)
os.environ['BALLISTICA_ROOT'] = os.getcwd()
starttime = time.monotonic() starttime = time.monotonic()
subprocess.run(['sphinx-apidoc', subprocess.run(['sphinx-apidoc',
@ -264,6 +262,6 @@ def _run_sphinx() -> None:
subprocess.run( ['make', 'html'], check = True, cwd= sphinx_apidoc_out) subprocess.run( ['make', 'html'], check = True, cwd= sphinx_apidoc_out)
shutil.copytree(sphinx_apidoc_out + '_build/html/', build_dir, dirs_exist_ok=True) shutil.copytree(sphinx_apidoc_out + '_build/html/', build_dir, dirs_exist_ok=True)
shutil.rmtree(temp_modules_dir) # shutil.rmtree(temp_modules_dir)
duration = time.monotonic() - starttime duration = time.monotonic() - starttime
print(f'Generated sphinx documentation in {duration:.1f}s.') print(f'Generated sphinx documentation in {duration:.1f}s.')