doc/common/conf: Keep IDE conf settings.

We are going to be deleting the ide build files, so make sure we keep what's needed.
This commit is contained in:
Laurens Valk
2021-07-23 12:45:30 +02:00
parent f7239fc9a9
commit 434ff5e346
2 changed files with 27 additions and 4 deletions
-4
View File
@@ -42,10 +42,6 @@ from pybricks._common import Speaker # noqa E402
# this line of code grabbed from docs.readthedocs.org
ON_RTD = os.environ.get('READTHEDOCS', None) == 'True'
# Since tags cannot be passed via SPHINXOPTS on read the docs, add it manually.
if ON_RTD:
tags.add('main')
_pyproject = toml.load(os.path.join(TOP_DIR, 'pyproject.toml'))
# -- General configuration ------------------------------------------------
+27
View File
@@ -19,4 +19,31 @@ html_favicon = '../common/images/favicon.ico'
html_logo = '../common/images/pybricks-logo-rtd.png'
latex_logo = '../common/images/pybricks-logo-large.png'
# Build main docs for RTD by default.
# Since tags cannot be passed via SPHINXOPTS on read the docs, add it manually.
if os.environ.get('READTHEDOCS', None) == 'True':
tags.add('main') # noqa F821
# Addtional configuration of the IDE docs
if 'ide' in tags.tags: # noqa F821
_DISCLAIMER = ''
html_show_copyright = False
html_show_sphinx = False
html_css_files = ['css/ide.css']
html_js_files = ['js/ide.js']
imgmath_image_format = 'svg'
imgmath_use_preview = True # requires Sphinx v3
imgmath_latex_preamble = r'''
\usepackage{newtxsf}
'''
exec(open(os.path.abspath("../common/conf.py")).read())
# Addtional configuration of the IDE docs
if 'ide' in tags.tags: # noqa F821
extensions.remove('sphinx.ext.mathjax') # noqa F821
extensions.append('sphinx.ext.imgmath') # noqa F821
html_theme_options['prev_next_buttons_location'] = None # noqa F821