From 842c0bb158598af66496119e78f4c3e3bbc19eab Mon Sep 17 00:00:00 2001 From: Loup-Garou911XD Date: Thu, 28 Mar 2024 18:09:23 +0530 Subject: [PATCH 1/3] Added ballistica logo to every page --- src/assets/sphinx/static/conf.py | 36 ++++++++++++++------------ src/assets/sphinx/template/index.rst_t | 1 - tools/batools/docs.py | 2 +- 3 files changed, 21 insertions(+), 18 deletions(-) diff --git a/src/assets/sphinx/static/conf.py b/src/assets/sphinx/static/conf.py index 3096fce1..79dd4e7b 100644 --- a/src/assets/sphinx/static/conf.py +++ b/src/assets/sphinx/static/conf.py @@ -21,10 +21,20 @@ sys.path.append(os.path.abspath(ballistica_root + assets_dirs['ba_data'])) sys.path.append(os.path.abspath(ballistica_root + assets_dirs['dummy_modules'])) sys.path.append(os.path.abspath(ballistica_root + assets_dirs['efro_tools'])) +# -- Project information ----------------------------------------------------- +project = sphinx_settings['project_name'] +copyright = sphinx_settings['copyright'] +author = sphinx_settings['project_author'] +# The full version, including alpha/beta/rc tags +version = str(sphinx_settings['version']) +release = str(sphinx_settings['buildnum']) + + # -- Options for HTML output ------------------------------------------------- # for more themes visit https://sphinx-themes.org/ html_theme = 'furo' # python_docs_theme, groundwork, furo, sphinx_rtd_theme -html_title = sphinx_settings['project_name'] + ' ' + str(sphinx_settings['version']) + ' documentation' +html_title = project + ' ' + version + ' documentation' +html_show_sphinx = False # do not remove, sets the logo on side panel html_logo = sphinx_settings['ballistica_logo'] @@ -55,23 +65,17 @@ if html_theme == 'furo': 'navigation_with_keys': True, } - - - -# -- Project information ----------------------------------------------------- -project = sphinx_settings['project_name'] -copyright = sphinx_settings['copyright'] -author = sphinx_settings['project_author'] -# The full version, including alpha/beta/rc tags -version = str(sphinx_settings['version']) -release = str(sphinx_settings['buildnum']) - # -- General configuration --------------------------------------------------- -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. - +# append to pages +rst_epilog = """ +""" +# prepend to pages +rst_prolog = f""" +.. image:: {html_logo} + :target: index.html + :alt: Ballistica Logo +""" intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} autosummary_generate = True extensions = [ diff --git a/src/assets/sphinx/template/index.rst_t b/src/assets/sphinx/template/index.rst_t index 3ebebcfa..4f8366f2 100644 --- a/src/assets/sphinx/template/index.rst_t +++ b/src/assets/sphinx/template/index.rst_t @@ -4,7 +4,6 @@ contain the root `toctree` directive. see https://pradyunsg.me/furo/reference/ and https://en.wikipedia.org/wiki/ReStructuredText for formatting help -.. image:: {{data.ballistica_image_url}} Welcome to ballistica-bombsquad's documentation! ================================================ diff --git a/tools/batools/docs.py b/tools/batools/docs.py index a6eafeff..632c2663 100755 --- a/tools/batools/docs.py +++ b/tools/batools/docs.py @@ -280,7 +280,7 @@ def _run_sphinx( paths['sphinx_cache_dir'] + 'index.rst', 'w', encoding='utf-8' ) as index_rst: data = { - 'ballistica_image_url': 'https://camo.githubusercontent.com/25021344ceaa7def6fa6523f79115f7ffada8d26b4768bb9a0cf65fc33304f45/68747470733a2f2f66696c65732e62616c6c6973746963612e6e65742f62616c6c6973746963615f6d656469612f62616c6c6973746963615f6c6f676f5f68616c662e706e67', # pylint: disable=line-too-long + # 'ballistica_image_url': 'https://camo.githubusercontent.com/25021344ceaa7def6fa6523f79115f7ffada8d26b4768bb9a0cf65fc33304f45/68747470733a2f2f66696c65732e62616c6c6973746963612e6e65742f62616c6c6973746963615f6d656469612f62616c6c6973746963615f6c6f676f5f68616c662e706e67', # pylint: disable=line-too-long 'version_no': version, 'build_no': str(buildnum), } From 4410261485d3e9668fe8194e9e95a7e664222e74 Mon Sep 17 00:00:00 2001 From: Loup-Garou911XD Date: Sat, 30 Mar 2024 02:28:11 +0530 Subject: [PATCH 2/3] Updating github actions --- .github/workflows/cd.yml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml index acb36a76..00ccafc8 100644 --- a/.github/workflows/cd.yml +++ b/.github/workflows/cd.yml @@ -22,7 +22,7 @@ jobs: - name: Make the build run: make prefab-gui-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: linux_x86_64_gui_(debug) path: build/prefab/full/linux_x86_64_gui @@ -42,7 +42,7 @@ jobs: - name: Make the build run: make prefab-server-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: linux_x86_64_server_(debug) path: build/prefab/full/linux_x86_64_server @@ -62,7 +62,7 @@ jobs: - name: Make the build run: make prefab-linux-arm64-gui-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: linux_arm64_gui_(debug) path: build/prefab/full/linux_arm64_gui @@ -82,7 +82,7 @@ jobs: - name: Make the build run: make prefab-linux-arm64-server-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: linux_arm64_server_(debug) path: build/prefab/full/linux_arm64_server @@ -102,7 +102,7 @@ jobs: - name: Make the build run: make prefab-mac-x86-64-gui-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: mac_x86_64_gui_(debug) path: build/prefab/full/mac_x86_64_gui @@ -122,7 +122,7 @@ jobs: - name: Make the build run: make prefab-mac-x86-64-server-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: mac_x86_64_server_(debug) path: build/prefab/full/mac_x86_64_server @@ -142,7 +142,7 @@ jobs: - name: Make the build run: make prefab-mac-arm64-gui-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: mac_arm64_gui_(debug) path: build/prefab/full/mac_arm64_gui @@ -162,7 +162,7 @@ jobs: - name: Make the build run: make prefab-mac-arm64-server-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: mac_arm64_server_(debug) path: build/prefab/full/mac_arm64_server @@ -182,7 +182,7 @@ jobs: - name: Make the build run: make prefab-windows-x86-gui-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: windows_x86_gui_(debug) path: build/prefab/full/windows_x86_gui @@ -202,7 +202,7 @@ jobs: - name: Make the build run: make prefab-windows-x86-server-debug-build - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: windows_x86_server_(debug) path: build/prefab/full/windows_x86_server @@ -222,7 +222,7 @@ jobs: - name: Make the build run: make docs-sphinx - name: Upload the build - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: sphinx_html_docs path: build/sphinx \ No newline at end of file From 1c95aa4e8dd992e46adbd82cd4acfb09364f83a9 Mon Sep 17 00:00:00 2001 From: Loup-Garou911XD Date: Sun, 28 Apr 2024 11:46:06 +0530 Subject: [PATCH 3/3] added view source option to sphinx docs --- src/assets/sphinx/static/conf.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/assets/sphinx/static/conf.py b/src/assets/sphinx/static/conf.py index 79dd4e7b..fd826ef0 100644 --- a/src/assets/sphinx/static/conf.py +++ b/src/assets/sphinx/static/conf.py @@ -76,11 +76,12 @@ rst_prolog = f""" :target: index.html :alt: Ballistica Logo """ -intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} +# intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} autosummary_generate = True extensions = [ - 'sphinx.ext.napoleon', # https://stackoverflow.com/questions/45880348/how-to-remove-the-cause-of-an-unexpected-indentation-warning-when-generating-cod + 'sphinx.ext.napoleon', 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', # might want to use this in future # for linking with efro and bacommon packages 'sphinx.ext.intersphinx',