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), }