removing docs output from repo (will now be stored externally)

This commit is contained in:
Eric Froemling 2022-03-21 15:57:12 -05:00
parent 900c2699a4
commit 538add066f
No known key found for this signature in database
GPG Key ID: 89C93F0F8D6D5A98
13 changed files with 51 additions and 7562 deletions

View File

@ -3971,26 +3971,26 @@
"assets/src/ba_data/python/ba/_generated/__init__.py": "https://files.ballistica.net/cache/ba1/ee/e8/cad05aa531c7faf7ff7b96db7f6e",
"assets/src/ba_data/python/ba/_generated/enums.py": "https://files.ballistica.net/cache/ba1/b2/e5/0ee0561e16257a32830645239f34",
"ballisticacore-windows/Generic/BallisticaCore.ico": "https://files.ballistica.net/cache/ba1/89/c0/e32c7d2a35dc9aef57cc73b0911a",
"build/prefab/full/linux_arm64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/26/ae/7c8af23412d9d04335e402ddbf9d",
"build/prefab/full/linux_arm64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/bd/38/b3898f07aaac32b00830e8163c98",
"build/prefab/full/linux_arm64_gui/release/ballisticacore": "https://files.ballistica.net/cache/ba1/74/1d/fc9e33e565475daaac80da5252f0",
"build/prefab/full/linux_arm64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/0a/a1/eac81af18bc6ac8823243b438b65",
"build/prefab/full/linux_arm64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/ea/05/441b048a2e1174283f8b95e2f16e",
"build/prefab/full/linux_x86_64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/ea/a7/2f14522135245ebce9d839209d14",
"build/prefab/full/linux_arm64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/c5/5b/e978fee41fbfc55c16d718c56f1f",
"build/prefab/full/linux_arm64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/1a/b8/75e1e4054c97774d4405f3e60e20",
"build/prefab/full/linux_x86_64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/18/e4/3562125e72905dd065f684dbce1e",
"build/prefab/full/linux_x86_64_gui/release/ballisticacore": "https://files.ballistica.net/cache/ba1/9c/7b/ac1a200be0f37078af0991faca3b",
"build/prefab/full/linux_x86_64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/f0/fa/a161aff6b435b9ed9420045d1c00",
"build/prefab/full/linux_x86_64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/2d/cd/32238ca3903e965d6c0322d651ca",
"build/prefab/full/mac_arm64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/cd/99/6cf86c869041eb1d4ff1677c9e0a",
"build/prefab/full/mac_arm64_gui/release/ballisticacore": "https://files.ballistica.net/cache/ba1/1c/05/ddc9aab1e428bd19383a23613974",
"build/prefab/full/mac_arm64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/04/e7/6e1c95c0180a97d8f6c849a47127",
"build/prefab/full/mac_arm64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/44/22/56185cfcb528851c0ea37faab887",
"build/prefab/full/mac_x86_64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/61/fe/4bd8946c8548e8aa5e13e8368257",
"build/prefab/full/mac_x86_64_gui/release/ballisticacore": "https://files.ballistica.net/cache/ba1/ed/a1/74dc56833d670717ae11a43065fc",
"build/prefab/full/mac_x86_64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/fd/0d/6860ed62dc186a137c9af1b9e07c",
"build/prefab/full/mac_x86_64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/80/a5/ffe47a5f7ee8301882b6feaec519",
"build/prefab/full/windows_x86_gui/debug/BallisticaCore.exe": "https://files.ballistica.net/cache/ba1/9a/fa/71f421aae773b2c6ce745e1c5dda",
"build/prefab/full/windows_x86_gui/release/BallisticaCore.exe": "https://files.ballistica.net/cache/ba1/98/3b/394f5604d3a00d09a5574d90e192",
"build/prefab/full/windows_x86_server/debug/dist/BallisticaCoreHeadless.exe": "https://files.ballistica.net/cache/ba1/c0/b6/0d741679e9d31ddfb22fb89a6ff8",
"build/prefab/full/windows_x86_server/release/dist/BallisticaCoreHeadless.exe": "https://files.ballistica.net/cache/ba1/d6/c9/3373f8d6653dea09d247104b9dbe",
"build/prefab/full/linux_x86_64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/db/0b/97c15f40176f9107e3860372673c",
"build/prefab/full/linux_x86_64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/af/e7/a94f9f8c79201f1971e8780fabca",
"build/prefab/full/mac_arm64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/2a/f2/2c9ed65d62dcc09b5a6ac58e62dc",
"build/prefab/full/mac_arm64_gui/release/ballisticacore": "https://files.ballistica.net/cache/ba1/7e/92/bc8c924d00452e82b1c20e6f3416",
"build/prefab/full/mac_arm64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/1a/b7/10ce516d3d87a52bd3bdc2c4f608",
"build/prefab/full/mac_arm64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/e1/e0/62ce20987de8e415df695299b8c6",
"build/prefab/full/mac_x86_64_gui/debug/ballisticacore": "https://files.ballistica.net/cache/ba1/f0/2a/3847196162ec4d4dc5a52b7b6d78",
"build/prefab/full/mac_x86_64_gui/release/ballisticacore": "https://files.ballistica.net/cache/ba1/0b/c4/ecbb7d87c7aabafee7406489a4c7",
"build/prefab/full/mac_x86_64_server/debug/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/6c/2c/3944b52004b5ea5e55feda5d3d28",
"build/prefab/full/mac_x86_64_server/release/dist/ballisticacore_headless": "https://files.ballistica.net/cache/ba1/f6/f3/335de61de866f22bf445609ebfe9",
"build/prefab/full/windows_x86_gui/debug/BallisticaCore.exe": "https://files.ballistica.net/cache/ba1/00/62/a1db444b8b6afb4a854afe733356",
"build/prefab/full/windows_x86_gui/release/BallisticaCore.exe": "https://files.ballistica.net/cache/ba1/23/61/837c636ebba4507facd6ac2de82a",
"build/prefab/full/windows_x86_server/debug/dist/BallisticaCoreHeadless.exe": "https://files.ballistica.net/cache/ba1/1b/8f/3146eb6b965ed4c206a0daf4ee37",
"build/prefab/full/windows_x86_server/release/dist/BallisticaCoreHeadless.exe": "https://files.ballistica.net/cache/ba1/29/e8/5cffe93a0c72ec31d0ae2ec175fe",
"build/prefab/lib/linux_arm64_gui/debug/libballisticacore_internal.a": "https://files.ballistica.net/cache/ba1/21/91/eb4b0119f4980c19c8fdc636e493",
"build/prefab/lib/linux_arm64_gui/release/libballisticacore_internal.a": "https://files.ballistica.net/cache/ba1/6f/4b/34dcc5f14c2547f4c16cda7b05c1",
"build/prefab/lib/linux_arm64_server/debug/libballisticacore_internal.a": "https://files.ballistica.net/cache/ba1/5a/38/91689a90fad69186191b3d55dd70",
@ -4007,14 +4007,14 @@
"build/prefab/lib/mac_x86_64_gui/release/libballisticacore_internal.a": "https://files.ballistica.net/cache/ba1/2f/bb/31cc38cfadaa0f66772141b7e6ff",
"build/prefab/lib/mac_x86_64_server/debug/libballisticacore_internal.a": "https://files.ballistica.net/cache/ba1/b6/41/acfa81cf0a54a440609a63b757ab",
"build/prefab/lib/mac_x86_64_server/release/libballisticacore_internal.a": "https://files.ballistica.net/cache/ba1/d4/b5/483420d970e61d5f134345a3e324",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreGenericInternal.lib": "https://files.ballistica.net/cache/ba1/59/a7/2c69666a31c5bf1b61fb07f1bfd1",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreGenericInternal.pdb": "https://files.ballistica.net/cache/ba1/e4/64/4b6ec797f6ff2b1c14ac1741929d",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreHeadlessInternal.lib": "https://files.ballistica.net/cache/ba1/37/78/bc33b2f5a321d78045c42d7f7073",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreHeadlessInternal.pdb": "https://files.ballistica.net/cache/ba1/94/12/98981404149ae3fd8621df8c6004",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreGenericInternal.lib": "https://files.ballistica.net/cache/ba1/fc/8e/5d7e308db119dce9b8f856f58ea0",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreGenericInternal.pdb": "https://files.ballistica.net/cache/ba1/47/2a/d8f0a65e790f7718c7473ed1eff6",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreHeadlessInternal.lib": "https://files.ballistica.net/cache/ba1/cc/3b/ee696a2da986de862bf66ef5efe5",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreHeadlessInternal.pdb": "https://files.ballistica.net/cache/ba1/7d/e3/bb6dfc2d6286175251c74f80c6e7",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreGenericInternal.lib": "https://files.ballistica.net/cache/ba1/d9/63/db8e49802c7b4e8e80f814879ece",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreGenericInternal.pdb": "https://files.ballistica.net/cache/ba1/c6/e2/58f253b2663046d731c58d994154",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreHeadlessInternal.lib": "https://files.ballistica.net/cache/ba1/f4/93/43b813bc7d73c1ed6e9c5178428e",
"build/prefab/lib/windows/Debug_Win32/BallisticaCoreHeadlessInternal.pdb": "https://files.ballistica.net/cache/ba1/7c/33/a33d0344983bcc893143efe9505f",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreGenericInternal.lib": "https://files.ballistica.net/cache/ba1/a9/95/7fa0cb933a13925ece114c162428",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreGenericInternal.pdb": "https://files.ballistica.net/cache/ba1/5b/ec/6f0e9b54adb0d73985bcef1260eb",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreHeadlessInternal.lib": "https://files.ballistica.net/cache/ba1/3d/7a/2bd489c07cc529fb193460522df4",
"build/prefab/lib/windows/Release_Win32/BallisticaCoreHeadlessInternal.pdb": "https://files.ballistica.net/cache/ba1/78/93/467f019959ada2bfeeb083b365ef",
"src/ballistica/generated/python_embedded/binding.inc": "https://files.ballistica.net/cache/ba1/b3/15/7c6d580b3482870b5b058858624c",
"src/ballistica/generated/python_embedded/bootstrap.inc": "https://files.ballistica.net/cache/ba1/d3/db/e73d4dcf1280d5f677c3cf8b47c3"
}

View File

@ -68,4 +68,10 @@
<orderEntry type="jdk" jdkName="Python 3.9" jdkType="Python SDK" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
<component name="PackageRequirementsSettings">
<option name="requirementsPath" value="" />
</component>
<component name="PyDocumentationSettings">
<option name="analyzeDoctest" value="false" />
</component>
</module>

View File

@ -1,4 +1,4 @@
### 1.6.11 (20516, 2022-03-21)
### 1.6.11 (20522, 2022-03-21)
- Documentation is now generated using pdoc <https://pdoc.dev>. Thanks Dliwk!!
### 1.6.10 (20511, 2022-03-20)

View File

@ -17,9 +17,6 @@
# own ways.
DMAKE = $(MAKE) MAKEFLAGS= MKFLAGS= MAKELEVEL=
# Prefix used for output of docs/changelogs/etc. targets for use in webpages.
DOCPREFIX = "ballisticacore_"
# Set env-var BA_ENABLE_IRONY_BUILD_DB=1 to enable creating/updating a
# cmake compile-commands database for use with irony for emacs (and possibly
# other tools).
@ -124,10 +121,10 @@ dummymodule:
# Tell make which of these targets don't represent files.
.PHONY: help prereqs prereqs-clean assets assets-cmake assets-windows \
assets-windows-Win32 assets-windows-x64 \
assets-mac assets-ios assets-android assets-clean \
resources resources-clean meta meta-clean \
clean clean-list dummymodule
assets-windows-Win32 assets-windows-x64 \
assets-mac assets-ios assets-android assets-clean \
resources resources-clean meta meta-clean \
clean clean-list dummymodule
################################################################################
@ -677,8 +674,8 @@ pycharm-full: prereqs meta
# Tell make which of these targets don't represent files.
.PHONY: check check-full check2 check2-full \
cpplint cpplint-full pylint pylint-full mypy \
mypy-full pycharm pycharm-full
cpplint cpplint-full pylint pylint-full mypy \
mypy-full pycharm pycharm-full
################################################################################
@ -889,7 +886,7 @@ clion-staging: assets-cmake resources meta
# Tell make which of these targets don't represent files.
.PHONY: cmake cmake-build cmake-clean cmake-server cmake-server-build \
cmake-server-clean
cmake-server-clean
################################################################################
@ -1029,4 +1026,4 @@ docs:
# Tell make which of these targets don't represent files.
.PHONY: _cmake-simple-ci-server-build _windows-wsl-build _windows-wsl-rebuild \
docs
docs

View File

@ -19,7 +19,6 @@ TA = TypeVar('TA', bound='Actor')
class Actor:
# noinspection PyUnresolvedReferences
"""High level logical entities in a ba.Activity.
Category: **Gameplay Classes**

View File

@ -138,7 +138,6 @@ def get_type_name(cls: type) -> str:
class _WeakCall:
# noinspection PyUnresolvedReferences
"""Wrap a callable and arguments into a single callable object.
Category: **General Utility Classes**
@ -226,7 +225,6 @@ class _Call:
"""
def __init__(self, *args: Any, **keywds: Any):
# noinspection PyUnresolvedReferences
"""Instantiate a Call.
Pass a callable as the first arg, followed by any number of
@ -362,7 +360,6 @@ def _verify_object_death(wref: weakref.ref) -> None:
def storagename(suffix: str = None) -> str:
# noinspection PyUnresolvedReferences
"""Generate a unique name for storing class data in shared places.
Category: **General Utility Functions**

View File

@ -365,7 +365,6 @@ class LanguageSubsystem:
class Lstr:
# noinspection PyUnresolvedReferences
"""Used to define strings in a language-independent way.
Category: **General Utility Classes**

File diff suppressed because it is too large Load Diff

View File

@ -21,7 +21,7 @@
namespace ballistica {
// These are set automatically via script; don't modify them here.
const int kAppBuildNumber = 20516;
const int kAppBuildNumber = 20522;
const char* kAppVersion = "1.6.11";
// Our standalone globals.

View File

@ -762,66 +762,6 @@ def filter_server_config(projroot: str, infilepath: str) -> str:
_get_server_config_template_yaml(projroot))
def update_docs_md(check: bool) -> None:
"""Updates docs markdown files if necessary."""
# pylint: disable=too-many-locals
from efrotools import get_files_hash
docs_path = 'docs/ba_module.md'
# We store the hash in a separate file that only exists on private
# so public isn't full of constant hash change commits.
# (don't care so much on private)
docs_hash_path = '.cache/ba_module_hash'
# Generate a hash from all c/c++ sources under the python subdir
# as well as all python scripts.
pysources = []
exts = ['.cc', '.c', '.h', '.py']
for basedir in [
'src/ballistica/python',
'tools/efro',
'tools/bacommon',
'assets/src/ba_data/python/ba',
]:
assert os.path.isdir(basedir), f'{basedir} is not a dir.'
for root, _dirs, files in os.walk(basedir):
for fname in files:
if any(fname.endswith(ext) for ext in exts):
pysources.append(os.path.join(root, fname))
pysources.sort()
storedhash: Optional[str]
curhash = get_files_hash(pysources)
# Extract the current embedded hash.
if os.path.exists(docs_hash_path):
with open(docs_hash_path, encoding='utf-8') as infile:
storedhash = infile.read()
else:
storedhash = None
if (storedhash is None or curhash != storedhash
or not os.path.exists(docs_path)):
if check:
raise RuntimeError('Docs markdown is out of date.')
print(f'Updating {docs_path}...', flush=True)
subprocess.run('make docs', shell=True, check=True)
# Our docs markdown is just the docs html with a few added
# bits at the top.
with open('build/docs.html', encoding='utf-8') as infile:
docs = infile.read()
docs = ('<!-- THIS FILE IS AUTO GENERATED; DO NOT EDIT BY HAND -->\n'
) + docs
os.makedirs(os.path.dirname(docs_path), exist_ok=True)
with open(docs_path, 'w', encoding='utf-8') as outfile:
outfile.write(docs)
with open(docs_hash_path, 'w', encoding='utf-8') as outfile:
outfile.write(curhash)
print(f'{docs_path} is up to date.')
def cmake_prep_dir(dirname: str, verbose: bool = False) -> None:
"""Create a dir, recreating it when cmake/python/etc. versions change.

View File

@ -488,12 +488,6 @@ def gendocs() -> None:
batools.docs.generate(projroot=str(PROJROOT))
def update_docs_md() -> None:
"""Updates docs markdown files if necessary."""
import batools.build
batools.build.update_docs_md(check='--check' in sys.argv)
def list_pip_reqs() -> None:
"""List Python Pip packages needed for this project."""
from batools.build import get_pip_reqs

View File

@ -103,10 +103,6 @@ class Updater:
self._update_dummy_module()
# Docs checks/updates will only run with this env var set.
if os.environ.get('BA_ENABLE_DOCS_UPDATES') == '1':
self._update_docs()
# Though not technically necessary, let's go ahead and update
# irony compile-commands, tool configs, etc. as part of the
# update process. This lessens the chance we'll have tools
@ -661,15 +657,3 @@ class Updater:
check=True)
except Exception as exc:
raise CleanError('Error checking/updating dummy module.') from exc
def _update_docs(self) -> None:
# Update our docs/*.md files.
# We need to do this near the end because it may run the cmake build
# so its success may depend on the cmake build files having already
# been updated.
try:
subprocess.run(['tools/pcommand', 'update_docs_md'] +
self._checkarglist,
check=True)
except Exception as exc:
raise CleanError('Error checking/updating docs.') from exc

View File

@ -35,15 +35,15 @@ from batools.pcommand import (
python_android_patch, python_android_patch_ssl, python_apple_patch,
python_gather, python_winprune, capitalize, upper, efrocache_update,
efrocache_get, get_modern_make, warm_start_asset_build, gendocs,
update_docs_md, list_pip_reqs, install_pip_reqs, checkenv,
ensure_prefab_platform, prefab_run_var, make_prefab, lazybuild,
android_archive_unstripped_libs, efro_gradle, stage_assets,
update_assets_makefile, update_project, update_cmake_prefab_lib,
cmake_prep_dir, gen_binding_code, gen_flat_data_code, wsl_path_to_win,
wsl_build_check_win_drive, win_ci_binary_build, genchangelog,
android_sdk_utils, update_resources_makefile, update_meta_makefile,
xcode_build_path, gen_python_enums_module, gen_python_init_module,
update_dummy_module, win_ci_install_prereqs)
list_pip_reqs, install_pip_reqs, checkenv, ensure_prefab_platform,
prefab_run_var, make_prefab, lazybuild, android_archive_unstripped_libs,
efro_gradle, stage_assets, update_assets_makefile, update_project,
update_cmake_prefab_lib, cmake_prep_dir, gen_binding_code,
gen_flat_data_code, wsl_path_to_win, wsl_build_check_win_drive,
win_ci_binary_build, genchangelog, android_sdk_utils,
update_resources_makefile, update_meta_makefile, xcode_build_path,
gen_python_enums_module, gen_python_init_module, update_dummy_module,
win_ci_install_prereqs)
# pylint: enable=unused-import
if TYPE_CHECKING: